From dc0f4d0a56e5d8b28511ac96e5c8232613aa72ee Mon Sep 17 00:00:00 2001 From: Barrie Byron Date: Fri, 22 Oct 2021 09:48:45 -0400 Subject: [PATCH 1/2] create CODEOWNERS file --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 79be2a2e..869c86f3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,14 +2,14 @@ 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 `master` branch contains the latest development version. -We follow standard github best practices: +We follow standard GitHub best practices: - Fork the repository - Make sure your `branch` is from the tip of `master` branch - Make some commits to resolve an issue - Submit a pull request to `master` -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 From 9a2eb0c4d953a76a265435727d030a9b585cbdf0 Mon Sep 17 00:00:00 2001 From: Barrie Byron Date: Fri, 22 Oct 2021 09:57:09 -0400 Subject: [PATCH 2/2] move codeowners from contributing file to the CODEOWNERS file --- CODEOWNERS | 7 +++++++ CONTRIBUTING.md | 11 +++++++---- 2 files changed, 14 insertions(+), 4 deletions(-) create mode 100644 CODEOWNERS 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 869c86f3..06dac390 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 `master` branch contains the latest development version. +We welcome contributions to our codebase and documentation. + +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 `master` branch contains the latest development version. We follow standard GitHub best practices: - Fork the repository - Make sure your `branch` is from the tip of `master` branch -- Make some commits to resolve an issue +- Make your commits to resolve an issue - Submit a pull request to `master` 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