Skip to content

Creating a new Pull Request

Tristan Matthias edited this page Apr 24, 2020 · 3 revisions

❗️This is a very important step for all PRs ❗️

When creating a new PR:

  • A title relevant to what you fixed
  • Include Fixes #NUMBER_OF_THE_ISSUE in the description of the PR.
  • The number of the issue it’s linked to (if it fixes multiple issues, tag these too).
  • Bullet points on what was added/fixed/changed in the description of PRs.

Once it is created, a maintainer 🧢 needs to be requested to review


✅ Good PR example

Title: feat: login testing

Description:

- Fixes #100      (when you press #, it gives you an autocomplete)
- Added tests for `login` mutation
- Added handler functions for success and fail.   
- Deleted dummy functions

Why is this good?

  • title explains a good synopsis of what the PR does at a glance
  • ✅ Tags the issue correctly with Fixes #ISSUE_NUMBER
  • ✅ Describes high level points of all the changes in the PR

❌ Bad PR example

Title: some_changes

Description:

- Fixed tests.     (What tests?? What issue # was it??)
- General changes. (What changes?? Be specific)

Why is this bad?

  • title is generic, and tells us nothing at a glance
  • ❌ Does not tag an issue (why this PR was done in the first place)
  • ❌ Gives no context or information as to why this PR was created or what was changed

❓Why is this important?

That's a great question!.
It links everything together and closes the original ticket which means it will automatically move the issue on the project board, and close it once the PR is merged. And then you will be able to see the finished issues on the closed board.

Please be careful when you link #, we are fixing the #issues not #PRs 🙂
When you create a PR, you’re essentially saying, “This is ready to be merged in, and I want feedback”

Clone this wiki locally