Skip to content

Add hint about formatting to CONTRIBUTING.md #271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fedejeanne wants to merge 1 commit into
base: main
Choose a base branch
from
+1 −0
Open

Add hint about formatting to CONTRIBUTING.md #271

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ When you have set up your fork of a repository that you want to contribute to an
- If tests were added, they should meet the following criteria:
- They should **run**: check the logs and make sure they are being executed.
- They should **pass**: do not add broken tests.
- The PR doesn't introduce unnecessary formatting changes (if the code is not related to the fix, do not format it).
- If the PR has been reviewed and the reviewer left some comments, address them and clearly document what you did. Either write a proper response like "addressed in commit _XYZ_" or explain why you did what you did. A mere "thumbs up" is not enough.

5. **Merging the PR:** Once the PR is approved, it can be merged by a committer
Expand Down