docs: update CONTRIBUTING pull request section #439
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportBase: 72.48% // Head: 72.48% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #439 +/- ##
=======================================
Coverage 72.48% 72.48%
=======================================
Files 32 32
Lines 985 985
=======================================
Hits 714 714
Misses 203 203
Partials 68 68 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
nikoksr
requested changes
Oct 25, 2022
There was a problem hiding this comment.
Nice @svaloumas looks good to me. All I could think of is switching the instruction order. The linter may complain about a file not being gofumpt-ed, so it may be more natural to run the formatter before the linter.
Not that I really expect anyone to strictly follow this guide in this particular order 😁
nikoksr
approved these changes
Oct 26, 2022
jidicula
added a commit
to jidicula/notify
that referenced
this pull request
Oct 27, 2022
Since we're now requiring gofumpt for this project in its contribution guidelines, it should be added to CI to ensure that new PRs are formatted correctly. Related to: nikoksr#439
This was referenced Oct 27, 2022
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updates the
Pull Requestsection inCONTRIBUTING.md. Adds an extra step to includemake fmtbefore opening a new PR.Motivation and Context
As mentioned by @arnocornette at this comment, it would be nice if we included a step in our contributing guidelines doc, describing the required actions to format the code properly before opening a new PR.
How Has This Been Tested?
Screenshots / Output (if appropriate):
Types of changes
Checklist: