[Documentation Suggestion] Update contributing guide to make PRs more friendly
mjaskula opened this issue · comments
Update contributing guide to make PRs more friendly
From Nik (@gamecat69) via discord:
I think we need a better way of merging code from other developers into the upstream branch BTW. Observations so far:
Positives:
- Pro-tips provided by admins really help people write better code
Cons:
- There are no rules published anywhere, other than rolling rules which are revealed by admins when a PR is created
- Developers must maintain their own branch exactly the same as upstream, rather then being able to specify particular files to push upstream. There may be some better git-foo to be learned here, but there is no guidance published anywere in the main repo to help people
- Sometimes coding preferences as comments by admins can be misunderstood as "things that need to be done to get this PR through"
contributing.md should be updated to address the above concerns. Additionally, it should include a section on how PR reviewers should participate in PRs as well.
This looks like a good doc to link to for con #2:
Additional guidance from Nik (@gamecat69) via discord:
- Every comment on a PR from admins must clearly state if it is a blocker for PR approval or not.
- Rules must be published to state what will prevent approval of a PR request.
- A solution and suitable guidance for devs must be in place to allow devs to have some deviation from the upstream repo in their repo for their own use.
Included standard differences between changes to scripts and changes to firmware.