Contributing Guideline

[Patamap]

Specification is needed.

Refer to GSOD proposal task https://docs.google.com/document/d/1MoSOYdlUFV2ar9e_rG4P43ucwoMUO2mTQ9pjetRGdaY/edit

@gmajan Refer to https://github.com/moja-global/About_moja_global/issues/69

[gmajan]

This task has several dimensions and I do not know whether all these can be covered as part of the GSoD. I can think of the following:

1. The GSoD proposal states that we need to update the Import-me repo to make sure that every new repo starts from the same basis. This includes a clear (i.e. easy to understand) explanation how one should contribute.
2. The guidelines we provide in each repo have to be clear and very easy to understand quickly. While all the info is more or less available in the contribution folder https://github.com/moja-global/About_moja_global/tree/master/Contributing; it is too hard to get an overview quickly. So we have a quick overview to help contributors with guidance https://github.com/moja-global/About_moja_global/blob/master/CONTRIBUTING.md We need to review whether this overview provides all the necessary info and whether we can make it simpler and easier to understand.
3. Some contribution guidelines need to be updated: 3.a. Create a repository needs to have the repo naming convention and the import-me repo instructions: https://github.com/moja-global/About_moja_global/blob/master/Contributing/How-To-Create-a-Repository.md 3.b. How-to-manage-backlog-system needs to be updated in line with the new guidelines for project and issue management. https://github.com/moja-global/About_moja_global/blob/master/Contributing/How-To-Manage-Backlog-System.md 3.c. etc. (we need to review each item to see whether it needs updating.)
4. The contribution guidelines are not complete. Some issues are not covered: 4.a. CI https://github.com/moja-global/About_moja_global/blob/master/Contributing/How-To-Continuous-Integration.md 4.b. Coding Style Guide: we indicated that we would use the Google style guide https://google.github.io/styleguide/cppguide.html but it is not clearly mentioned anywhere. 4.c. We wanted to standardized the criteria for the code (e.g. speed, max length, etc.) but we have not completed that discussion yet. https://github.com/moja-global/About_moja_global/blob/master/Governance/Contribution-Criteria.md Parth is working on a tool to measure speed. This is a first step. We need to plan how we are going to include this test into future contributions.

There might be other aspects that I have not listed here. Feel free to break this up into smaller items.

[Tlazypanda]

Hey @gmajan Thanks for such a detailed explanation :tada: This is elaborate but I am sure if we get started as early as possible we can capture most of it :v:

Also the 4th point right now has items that are in-progress so let's try to check items off that list as soon as possible so in the GSoD period we can just focus on the documentation part of it.

[Tlazypanda]

@gmajan @Patamap Pulling zulipbot guidelines here:-

• Add zulipbot usage instructions to import me repository and informing all contributors to pull changes from import-me repo for the same.