Skip to content

Instantly share code, notes, and snippets.

@tawn33y

tawn33y/Opening PRs.md

Last active August 8, 2022 16:11
Show Gist options
  • Save tawn33y/a380c176265d5b060c5c722f1e89d79f to your computer and use it in GitHub Desktop.
Save tawn33y/a380c176265d5b060c5c722f1e89d79f to your computer and use it in GitHub Desktop.
Download ZIP
Raw
Opening PRs.md

A few recommended community guidelines on opening PRs for good code quality on the whatsapp-cloud-api repo:

  • Open a new branch from staging (not main) with the prefix feature/ISSUE-XX, where XX is the issue number, e.g. feature/ISSUE-10
  • Make your changes and add tests for them.
  • Run the linter, ensure all tests pass, and then create a build. See more under the Development docs.
  • Ensure the build size does not substantially grow the currently published size on the npmjs.com page. You can run npm pack to verify the new package size, then look at the Properties of the created tgz file.
  • Commit the changes with a well descriptive message with the format: feature/ISSUE-XX Some message here, e.g. feature/ISSUE-10 Add logging when starting an express server
  • Open a PR to the staging branch with the title format feature/ISSUE-XX Some message here, e.g. feature/ISSUE-10 Add logging when starting an express server.
    • Be sure to tag the issue in the PR description, e.g. This fixes #10.
    • Add a label that best describes the changes, e.g. enhancement, bug fixes, etc.
    • Here is an example: tawn33y/whatsapp-cloud-api#17
  • Ensure all Github Actions CI tests pass & fix code appropriately if they fail.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment