Skip to content

Commit

Permalink
docd: update contributing guides with go.mod and lint work
Browse files Browse the repository at this point in the history
  • Loading branch information
mdelapenya committed Jun 14, 2024
1 parent 908ea83 commit cecbcdf
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,9 @@
* follow the style, naming and structure conventions of the rest of the project.
* make commits atomic and easy to merge.
* when updating documentation, please see [our guidance for documentation contributions](contributing_docs.md).
* apply format running `go fmt`, or the shell script `./scripts/checks.sh`
* when updating the `go.mod` file, please run `make tidy-all` to ensure all modules are updated. Please be aware that the lint stage could fail if this is not done.
* apply format running `make lint`
* For examples: `make -C examples lint`
* For modules: `make -C modules lint`
* verify all tests are passing. Build and test the project with `make test-all` to do this.
* For a given module or example, go to the module or example directory and run `make test`.

0 comments on commit cecbcdf

Please sign in to comment.