Proposed to add/update the content in https://github.com/moja-global/About_moja_global/blob/master/CONTRIBUTING.md
1) Add "Table of contents" link to able to see the overview in once and able to select the one that wanted to read.
- Code of Conduct
- FAQ and General Questions
- How To Get Credit for Your Contribution?
- How to Contribute Code?
- How to Report Bugs, Provide Feedback or Request Features?
- How to Review & Contribute to Science Design?
- How to Suggest UI/UX Improvements?
- How to Contribute Translations?
- Are There Other Ways of Contributing?
2) Add 4 Subjects: "Contribute what?", "Ground rules", "Getting started" and "Code review process"
3) Add "Contribute what?"
There are different ways to contribute to a project. Some ways to contribute are…
Writing code.
Submitting bug reports/feature requests
Improving documentation
Writing tutorials posts
4) Add subject "Ground rules"
Ground rules
These ground rules are the basic responsibilities for contributing to the project.
DO's
DO run unit tests before submitting a pull request
DO create issues first for major changes/enhancements you want to make
Discuss things transparently first and get community feedback
DO keep each pull request to one feature/bug fix.
If you want to submit multiple things, submit multiple pull requests
DO write unit tests for new features
DO write good commit messages <add link https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html"72
DON'Ts
DON'T commit changes to files irrelevant to your pull request.
5). Add subject "Getting started"
Working on your first pull request? Learn how from this free series. How to Contribute to an Open Source Project on GitHub
- Fork the project to your GitHub account.
- Create changes in your fork.
- Run unit tests once you're done.
- Send a pull request to our repo.
6) Add subject "Code Review Process"
The core team of Moja Global reviews pull requests on a weekly basis. The core team may vary – see an updated list in the
<add the link that shows who are the maintanent in each repo)
Expect a response on new pull requests within five business days? (Mon-Fri). If you don't receive any feedback, please follow up with a new comment!6
@gmajan @Tlazypanda May I have your opinion, please for these CONTRIBUTING page?
Refer to #63
Proposed to add/update the content in https://github.com/moja-global/About_moja_global/blob/master/CONTRIBUTING.md
1) Add "Table of contents" link to able to see the overview in once and able to select the one that wanted to read.
2) Add 4 Subjects: "Contribute what?", "Ground rules", "Getting started" and "Code review process"
3) Add "Contribute what?"
There are different ways to contribute to a project. Some ways to contribute are…
Writing code.
Submitting bug reports/feature requests
Improving documentation
Writing tutorials posts
4) Add subject "Ground rules"
Ground rules
These ground rules are the basic responsibilities for contributing to the project.
DO's
DO run unit tests before submitting a pull request
DO create issues first for major changes/enhancements you want to make
Discuss things transparently first and get community feedback
DO keep each pull request to one feature/bug fix.
If you want to submit multiple things, submit multiple pull requests
DO write unit tests for new features
DO write good commit messages <add link https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html"72
DON'Ts
DON'T commit changes to files irrelevant to your pull request.
5). Add subject "Getting started"
Working on your first pull request? Learn how from this free series. How to Contribute to an Open Source Project on GitHub
6) Add subject "Code Review Process"
The core team of Moja Global reviews pull requests on a weekly basis. The core team may vary – see an updated list in the
<add the link that shows who are the maintanent in each repo)
Expect a response on new pull requests within five business days? (Mon-Fri). If you don't receive any feedback, please follow up with a new comment!6
@gmajan @Tlazypanda May I have your opinion, please for these CONTRIBUTING page?
Refer to #63