[NEMO-322] Committer's Guide (#186)
JIRA: [NEMO-322: Committer's Guide](https://issues.apache.org/jira/projects/NEMO/issues/NEMO-322)
**Major changes:**
- None
**Minor changes to note:**
- Adds a committer's guide to the repository
**Tests for the changes:**
- N/A
**Other comments:**
- None
Closes #186
diff --git a/.github/COMMITTING.md b/.github/COMMITTING.md
new file mode 100644
index 0000000..b782072
--- /dev/null
+++ b/.github/COMMITTING.md
@@ -0,0 +1,45 @@
+# Committing to Nemo
+
+## Becoming a Committer
+
+To get started contributing to Nemo, refer to the [contributor's guide](CONTRIBUTING.md).
+
+Based on the contributions of the contributors for Nemo, PMC regularly adds new committers from the active contributors.
+The qualifications for new committers include
+
+1. Sustained contributions to Nemo
+2. Quality of contributions
+3. Community involvement
+
+The type and level of contributions considered may vary by project area - code itself, documentations, platform support for specific OSes, storage systems, etc.
+
+## How to Merge a Pull Request
+
+Changes pushed to the master branch on Apache cannot be removed; that is, we can’t force-push to it. So please don’t add any test commits or anything like that, only real patches.
+
+The easiest way to merge Pull Requests on Nemo is to use the GitHub Pull Requests interface.
+The Pull Request interface looks something like below.
+
+
+
+Upon merging, GitHub checks if the CI tests show successful runs, and blocks the merge if the tests fail.
+It also checks if it has an approving review, as well as if the branch is up-to-date with the master branch.
+If the merge can be handled without any conflicts, GitHub provides the 'Update branch' button, which automatically merges the master branch straight from the GitHub UI.
+
+
+
+With adequate approvals from the existing committers, as well as other status checks, you will be able to see the squash and merge button as below.
+If you see something else, please use the 'Squash and merge' option, by clicking on the green arrow button next to the green button describing the action.
+
+
+
+After clicking on the button, you should see the options to fill out the commit title and the contents.
+
+
+
+Please copy & paste the title of the PR, that has been shown at the top of the PR interface, and the PR descriptions.
+You can get the PR description in full text by clicking on the ... button of the PR description and clicking on the 'Edit' button.
+
+
+
+After then, by hitting 'Confirm squash and merge', you can perform a successful merge! Congrats! :tada:
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 80d0cd9..845d932 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -13,6 +13,8 @@
When you contribute code, you affirm that the contribution is your original work and that you license the work to the project under the project's open source license. Whether or not you state this explicitly, by submitting any copyrighted material via pull request, email, or other means you agree to license the material under the project's open source license and warrant that you have the legal authority to do so.
+Also, we have a [dev list](mailto:dev@nemo.apache.org), where you can ask questions before contributing.
+
## Things to know before getting started
- [Our Docs](http://nemo.apache.org/docs/home/)
@@ -41,4 +43,6 @@
6. [Open a pull request](https://github.com/apache/incubator-nemo/pull/new/master) following the [PR template](pull_request_template.md).
- the PR title should be of form `[NEMO-##] Title`, specifying the relevant JIRA ticket number, and a short description of the change.
- if the PR is still a work in progress and is not ready to be merged, add `[WIP]` before the title.
+ - Set yourself as the assignee, this is a little trick for how we easily identify the author of each PRs.
- Consider identifying the reviewer of the PR, with the suggestions provided by GitHub.
+ - Be sure to replace the `#GITHUB_PR_NUMBER` on your PR message with the appropriate PR number on GitHub, by hitting on edit after sending your PR.
