Making a PR
- Use conventional commits
- 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.
- Familiarize yourself with Markdown.
- Provide beautiful screenshot(s) (shift + command + 4 on a Mac) or video recording(s) (shift + command + 5 on a Mac)
- Provide a Test Plan (steps to access the feature or reproduce the fixed bug)
Reviewing a PR
-
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.
-
Focus on what this PR is trying to solve or fix.
-
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}.
-
Use emojis.
-
Don't let perfection be the enemy of progress.