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

Add contributor guide #41

Open
6 tasks
fifieldt opened this issue Jun 27, 2020 · 1 comment
Open
6 tasks

Add contributor guide #41

fifieldt opened this issue Jun 27, 2020 · 1 comment
Labels
community documentation Improvements or additions to documentation

Comments

@fifieldt
Copy link
Collaborator

Many git repos have a dedicated CONTRIBUTING.md file that explain how to contribute in a bit more depth. Creating one of those is a good way to capture some of our 'tribal knowledge' about how we work together, making it easier for new people to jump in and feel confident they are doing the 'right' thing. To cover areas such as:

  • Who can get push rights, and who to contact to get them (at the moment, all comers should say hi and are given push rights)
  • How we communicate outside of github (ie our LINE group)
  • Encourage new contributors to add their name to about.md
  • When it's OK to merge a patch straight into master (deployment, typo fixes, non-contentious content updates, straightforward layout updates) and when we like to use an issue or pull request to review (updating/adding FAQ entries which could be contentious or it's difficult to say for sure we're correct, big layout changes)
  • Our collaboration 'principles'
  • how to find something to work on
@fifieldt fifieldt added community documentation Improvements or additions to documentation labels Jun 27, 2020
@geekyme
Copy link
Collaborator

geekyme commented Aug 27, 2020

On top of this one, probably its also a good idea to put in tools for code formatting / linting, etc. This way there can be some consistency between all contributors.

This was referenced Sep 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants