File tree Expand file tree Collapse file tree 1 file changed +41
-0
lines changed Expand file tree Collapse file tree 1 file changed +41
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Contributing
2
+
3
+ ## Feature requests
4
+
5
+ Desire a new timetrace feature? Just propose your idea by
6
+ [ creating an issue] ( https://github.com/dominikbraun/timetrace/issues/new ) .
7
+
8
+ Good feature proposals ...
9
+ * explain the problem that the feature solves.
10
+ * explain why it would be a desirable feature for the majority of users.
11
+
12
+ ## Reporting issues
13
+
14
+ If you encounter an unexpected behavior or a bug, feel free to
15
+ [ file an issue] ( https://github.com/dominikbraun/timetrace/issues/new ) . When you
16
+ do so, please make sure to ...
17
+ * include version information from the output of ` timetrace version ` .
18
+ * provide steps to reproduce the behavior.
19
+
20
+ ## Code contributions
21
+
22
+ ### Setting up local development
23
+
24
+ Developing timetrace only requires [ Go 1.16] ( https://golang.org/dl/ ) .
25
+
26
+ 1 . Fork the repository.
27
+ 2 . Clone your forked repository.
28
+ 3 . Run ` go run . version ` to verify that everything works.
29
+
30
+ ### Coding conventions
31
+
32
+ * All code has to follow the [ Effective Go] ( https://golang.org/doc/effective_go.html ) guidelines.
33
+ * All code has to be formatted with ` gofmt -s ` .
34
+ * Exported types and methods should be documented briefly. Explain what they're doing, not what they are.
35
+
36
+ ### Contributing changes
37
+
38
+ 1 . Make your changes. If needed, [ write tests] ( core/timetrace_test.go ) .
39
+ 2 . Run ` go run . <command> ` for testing your changes.
40
+ 3 . Run ` go test ./... ` to verify that all tests pass.
41
+ 4 . Commit your changes and open a PR.
You can’t perform that action at this time.
0 commit comments