Pull Requests

Making a PR

  1. Use conventional commits
  2. Provide a clear title and description. Provide some insight into the thought process behind your implementation. Add comments in code and/or to specific lines in a PR on GitHub to call out anything that might raise eyebrows.
  3. Familiarize yourself with Markdown.
  4. Provide beautiful screenshot(s) (shift + command + 4 on a Mac) or video recording(s) (shift + command + 5 on a Mac)
  5. Provide a Test Plan (steps to access the feature or reproduce the fixed bug)

Reviewing a PR

  1. Don't soley focus on code style. Computers are great at automation. Use tools like Prettier, ESLint, and PHP-CS-Fixer to take care of that for you. It feels less nitpicky when a computer points out a violation.

  2. Focus on what this PR is trying to solve or fix.

  3. Be mindful of your language. Ask questions instead of making statements.

    • Bad: You should do {suggest alternative} instead.
    • Better: It might be better if you did {suggest alternative} because {explain reasoning}.
    • Good: What do you think about doing {suggest alternative} instead so that {explain reasoning}.
  4. Use emojis.

  5. Don't let perfection be the enemy of progress.