Skip to content

doc: update CONTRIBUTING.md to address editing PRs

Rodrigo Muino Tomonari requested to merge github/fork/gibfahn/pr-contributing into master
Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

Add more info about the contribution process after PR submission.

  • One of the things I frequently see with new contributors is that people don't appreciate that raising a PR is only half the battle, the other half is fixing nits.
  • It's also a little discouraging to raise a PR and have changes suggested, especially if you weren't expecting it.
  • The other thing that often happens is people getting confused about how Github PRs work, I found it a bit unintuitive at first that the PR just points to your branch so you can just update your branch to update the PR. Obviously we don't want to start including Git tutorials, but this comes up often enough that I think it might be worth spelling it out.

Open to suggestions on any of this!

Merge request reports