You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+9-21Lines changed: 9 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,36 +4,24 @@ Contributions are welcome. Please note the [Code of Conduct](CODE_OF_CONDUCT.md)
4
4
5
5
## Tool & Repository setup
6
6
7
-
### Recommendations
8
-
9
-
CI pipelines check all code changes when you open a PR. To not have to go back and fix all issues manually, the following setup is recommended.
10
-
11
7
You will need the following tools:
12
8
13
9
-[go](https://go.dev/). For the specific version used, check the [pre-commit workflow](.github/workflows/pre-commit.yml) at the `go-version` configuration
14
10
-[pre-commit](https://pre-commit.com/)
15
11
16
-
Once this is done, run the following:
17
-
18
-
```sh
19
-
# Linters used with pre-commit
20
-
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
Once those are installed, run `make setup` to perform the repository setup.
27
13
28
-
If you want to hot reload the server, using `air` is recommended. Get it with
14
+
## Development server
29
15
30
-
```sh
31
-
go install github.com/cosmtrek/air@latest
32
-
```
33
-
34
-
You can then run `GIN_MODE=debug air` in the repository root, which will build and rebuild the project every time the code changes.
16
+
Run `make devserver` in the repository root, which will build and rebuild the project every time the code changes.
35
17
36
18
## Commit messages
37
19
38
20
This project uses [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/)
39
21
to enable better overview over changes and enables automated tooling based on commit messages.
22
+
23
+
## Tests & test coverage
24
+
25
+
The test coverage goal is 100%. Please try to add tests for everything you add to the codebase. If in doubt, you’re always welcome to open an issue and ask for help.
26
+
27
+
To run tests, run `make test`. To show the test coverage graphically in your browser, run `make coverage`.
0 commit comments