Routines for working with content on Github for Variant
We are open. This means we should work in an open way. Run like an open source project. Any significant amount of work* should be done through Pull Requests. Pull Requests are suggestions for a project which projects can accept and update their own content. This is a great way to frame discussions.
(* Significant amount of work in both scope and impact. Things like infrastructure, bug fixing, minor details can be committed directly to master without doing a Pull Request.
Pull Requests should be reviewed equally, no matter who created the pull request. Communication should be polite, friendly and welcoming. Even though the change isn't what we want, we should appreciate the work put into it and the effort.
When we get a Pull Request, two people should review it. If both people are happy, we can accept the changes (merge). If you see a Pull Request without reviewers: Set yourself as a reviewer and add one or more additional reviewers. If the content is of a change that is relevant to other people, add them as reviewers also.
Try to review as quickly as you are able and get the changes in. We do not want long running Pull Requests. That is demotivating for the people sending the pull requests and it is more work.
Creating a Pull Request
Try to include the following information:
- What is this change
- Why is this proposed
- If applicable: Include screenshots of the change. Not relevant on text changes only. See example
If you can, try adding the reviewers you think are relevant for this change.