humanetech-community / awareness-program

Humane Tech Community project for designing and launching public awareness campaigns
33 stars 4 forks source link

Document procedures and workflows for contributors and maintainers #16

Open aschrijver opened 6 years ago

aschrijver commented 6 years ago

This issue is just the starter of a bunch of activities aimed to make working with Github and this project easier and efficient, and - importantly - manageable when the number of collaborators grows.

This will all be added to easy to understand documentation at a later stage. For now I'll just add things of importance here.


There are 3 levels of access to this repo (and every other one in our organization):

Role Access level Description
Owner admin Full privilege
Maintainer write Can make direct changes to files / folders without submitting a Pull Request (PR). Maintainers are the custodians of the repository. They accept PR's, help contributors, ensure quality is maintained and improve project/repo structure. They can be seen as the 'admins' of the repo.
Contributor read (default) This is the level every Github user (and by extension every community member with a GH account) has. You can make changes to files and folders provided that you create a Pull Request first. This PR can then be reviewed by any other GH user, before it is accepted by a Maintainer or the Owner and is merged with the latest project content (the 'master' branch)

While Maintainers can commit directly to the files and folders in the 'master' branch, this should be avoided. It makes it really hard to control what has been changed. Instead - just like regular contributors - a Maintainer should create a PR, which can be reviewed before it is merged.


More info to come here..

aschrijver commented 6 years ago

This task is now part of the Aware Prepare: Growth hacking the Awareness Campaigns project campaign.

aschrijver commented 6 years ago

Note: Referenced PR contains a comment that can be adopted for documenting Editing procedures.