Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the content and 6 topics in Contributing page for easy, simple, concise for reading #69

Open
Patamap opened this issue Jun 29, 2020 · 3 comments
Labels
Documentation Issue / feature refers to docs not code Need clarification Propose a way to better communicate a feature P3 Low priority issue

Comments

@Patamap
Copy link
Contributor

Patamap commented Jun 29, 2020

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.

  1. Code of Conduct
  2. FAQ and General Questions
  3. How To Get Credit for Your Contribution?
  4. How to Contribute Code?
  5. How to Report Bugs, Provide Feedback or Request Features?
  6. How to Review & Contribute to Science Design?
  7. How to Suggest UI/UX Improvements?
  8. How to Contribute Translations?
  9. 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

  1. Fork the project to your GitHub account.
  2. Create changes in your fork.
  3. Run unit tests once you're done.
  4. 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

@Patamap Patamap added Need clarification Propose a way to better communicate a feature Documentation Issue / feature refers to docs not code P1 Medium priority issue T = 1 Hour P3 Low priority issue and removed P1 Medium priority issue labels Jun 29, 2020
@Patamap Patamap changed the title Updated the ground rule for CONTRIBUTING.md Updated the content in Contributing page for easy, simple, concise for reading Jun 29, 2020
@Patamap Patamap added this to the Technical Onboarding 2020 milestone Jun 29, 2020
@Patamap Patamap changed the title Updated the content in Contributing page for easy, simple, concise for reading Updated the content and 6 topics in Contributing page for easy, simple, concise for reading Jun 29, 2020
@Patamap Patamap changed the title Updated the content and 6 topics in Contributing page for easy, simple, concise for reading 77Updated the content and 6 topics in Contributing page for easy, simple, concise for reading Jun 29, 2020
@Patamap Patamap changed the title 77Updated the content and 6 topics in Contributing page for easy, simple, concise for reading Updated the content and 6 topics in Contributing page for easy, simple, concise for reading Jun 29, 2020
@Tlazypanda
Copy link
Collaborator

Main discussion at #63

@caseynv
Copy link

caseynv commented Oct 11, 2021

Hi, I am an outreachy applicant. I'd like to work on this.

@aornugent
Copy link
Contributor

Hi @caseynv - this issue is a little bit old. It might be important, but you should check with the docs team how it fits in with the 2021 content strategy. If you're on our Slack channel you can check out #documentation.

@HarshCasper - can we use Github discussions to communicate with the docs team, for anyone not on Slack?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issue / feature refers to docs not code Need clarification Propose a way to better communicate a feature P3 Low priority issue
Projects
None yet
Development

No branches or pull requests

5 participants