diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 00000000..eb45c36e --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,7 @@ +# CODEOWNERS: https://help.github.com/articles/about-codeowners/ + +# Docs +*.md @barriebyron + +# Primary repo maintainers +* @dongsam @kogisin @hallazzang \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 40e74dee..16854dfb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,18 +1,21 @@ # Contributing -We welcome contributions from anyone who is willing to create a new PR on farming module, make sure that you read and comply with this document. See the [open issues](https://github.com/tendermint/farming/issues) that we need help with. Feel free to inform us if you are willing to work on any issue. Note that the `main` branch contains the latest development version. +We welcome contributions to our codebase and documentation. -We follow standard github best practices: +Before you create a PR on the farming module, make sure that you read and comply with this document. See the [open issues](https://github.com/tendermint/farming/issues) that we need help with. + +Feel free to inform us if you are willing to work on an issue. Note that the `main` branch contains the latest development version. + +We follow standard GitHub best practices: - Fork the repository - Make sure your `branch` is from the tip of `main` branch -- Make some commits to resolve an issue +- Make your commits to resolve an issue - Submit a pull request to `main` -Rule of thumb: +General guidance: - Make sure you run tests by running `make test-all` locally to see there is any issue -- Review all the checks on your PR and review code coverage report -- Assign reviewers from code owners (@dongsam @kogisin @hallazzang) +- Review all the checks on your PR and review the code coverage report Thank you for your contribution! \ No newline at end of file