docs: add CONTRIBUTING.md

Gelio · Mar 14, 2022 · a20548f · a20548f
1 parent 22fee79
commit a20548f
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,18 @@
+# Contributing to go-global-update
+
+Contributions are welcome!
+
+Found a bug or want a new feature? Report an issue.
+
+Want to take a stab at making a code change? Pull requests are also welcome!
+
+## Pull request checklist
+
+Before submitting a pull request, make sure to complete the following steps:
+
+1. Format the code usign [gofumpt](https://github.com/mvdan/gofumpt)
+1. Ensure the tests pass by running `go test ./...`
+
+It is best if your change is covered by tests. If there are none, consider
+adding new test cases. Do not worry if you do not know how, we can figure it
+out during the pull request review.
diff --git a/README.md b/README.md
@@ -61,3 +61,7 @@ go-global-update --help
 
 1. If the binary has a newer version, run `go install [package path]@latest` to
    update it.
+
+## Contributing
+
+Contributions are welcome! See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.