Skip to content

Instantly share code, notes, and snippets.

@smyaseen
Last active November 19, 2023 15:06
Show Gist options
  • Save smyaseen/ab4ee4a159ba8071aaab6335c4d7423e to your computer and use it in GitHub Desktop.
Save smyaseen/ab4ee4a159ba8071aaab6335c4d7423e to your computer and use it in GitHub Desktop.
Extensive GitHub Pull Request Template

Description

What type of PR is this? (check all applicable)

  • ๐Ÿ• Feature - A new feature.
  • ๐Ÿ› Bug Fix - self-explanatory
  • ๐Ÿ“ Documentation Update - Documentation and related changes.
  • ๐ŸŽจ Style - Changes that do not affect the meaning of the code; for example, white space, formatting, or missing semicolons.
  • ๐Ÿง‘โ€๐Ÿ’ป Code Refactor - A code that neither fixes a bug nor adds a feature. (eg: You can use this when there is semantic changes like renaming a variable/ function name).
  • ๐Ÿ”ฅ Performance Improvements - A code change that improves performance.
  • โœ… Test - Added | Modified | Removed tests
  • ๐Ÿค– Build - Changes related to code building (e.g. adding npm dependencies or external libraries).
  • ๐Ÿ” CI - Changes that affect the build CI/CD pipeline
  • ๐Ÿ“ฆ Chore - Changes that do not affect the external user (e.g. updating the .gitignore file or .prettierrc file).
  • โฉ Revert - self-explanatory

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Quality Checklist

  • ๐Ÿ‘ทโ€โ™€๏ธ Created small PR.
  • ๐Ÿ‘ด๐Ÿป No deprecated or outdated code is introduced
  • ๐Ÿ’ญ Code is self-documenting. Comments are unnecessary and should only be used to explain why a decision was made
  • ๐Ÿ—’๏ธ Methods are documented with JS Doc including description, params, and return type
  • ๐Ÿ“‹ The commit message follows our guidelines
  • ๐Ÿ‘Œ The pull request description explains any decisions or trade-offs made regarding code quality and design
  • ๐Ÿ”– The branch follows our naming guidelines

Self Checklist

  • ๐Ÿ‘“ I have followed the style guidelines of this project
  • ๐Ÿคณ I have performed a self-review of my code
  • ๐Ÿท๏ธ I have correctly labelled PR & added Ticket Number
  • ๐Ÿ™†โ€โ™‚๏ธ I have cleared the Acceptance Criteria
  • โš ๏ธ My changes generate no new warnings

Added tests?

  • ๐Ÿ‘ yes, new and existing unit tests pass locally with my changes
    • โ™ป๏ธ had to make changes to existing tests
  • ๐Ÿฅน no, because I need help
    • โฎ๏ธ some existing tests are failing
  • โŒ› no time to add tests
  • ๐Ÿ™… no, because they aren't needed

Added to documentation?

  • ๐Ÿ“œ README.md
  • ๐Ÿ“ Confluence
  • ๐Ÿ™… no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment