chore: create pull_request_template.md #7726
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
This is the very first iteration of the lotus PR template. The goal of adding PR template is to standardize PR requests and encourage contributors to: - come up with good PR descriptions to give code reviewers a clear overview of what's in the PR - have a clear PR title as lotus generates a change log based on it - check that tests and documentation for the codes that changed are icnluded The PR type follows the https://www.conventionalcommits.org/en/v1.0.0-beta.2/. The [contribution guideline](https://github.com/filecoin-project/lotus#contribute) should be updated with how to create a pr after the template is accepted.
Codecov Report
@@ Coverage Diff @@
## master #7726 +/- ##
==========================================
- Coverage 39.59% 39.50% -0.10%
==========================================
Files 640 640
Lines 68326 68326
==========================================
- Hits 27056 26993 -63
- Misses 36631 36680 +49
- Partials 4639 4653 +14
Continue to review full report at Codecov.
|
magik6k
reviewed
Dec 2, 2021
.github/pull_request_template.md
Outdated
| Before you mark the PR ready for review, please make sure that: | ||
| - [ ] The PR title is in the form of of `<PR type>: <#issue number> <area>: <change being made>` | ||
| - example: ` fix: #1234 mempool: Introduce a cache for valid signatures` | ||
| - `PR type`: _fix_, _feat_, _BREAKING CHANGE_, _build_, _chore_, _ci_, _docs_, _perf_, _refactor_, _revert_, _style_, _test_ |
There was a problem hiding this comment.
whats the difference between chore and misc?
There was a problem hiding this comment.
i would think of something like "fix lint" as a chore.
There was a problem hiding this comment.
Not sure what a BREAKING CHANGE would count as
There was a problem hiding this comment.
i would think of something like "fix lint" as a chore.
and misc?
arajasek
reviewed
Dec 10, 2021
.github/pull_request_template.md
Outdated
| Before you mark the PR ready for review, please make sure that: | ||
| - [ ] The PR title is in the form of of `<PR type>: <#issue number> <area>: <change being made>` | ||
| - example: ` fix: #1234 mempool: Introduce a cache for valid signatures` | ||
| - `PR type`: _fix_, _feat_, _BREAKING CHANGE_, _build_, _chore_, _ci_, _docs_, _perf_, _refactor_, _revert_, _style_, _test_ |
There was a problem hiding this comment.
i would think of something like "fix lint" as a chore.
.github/pull_request_template.md
Outdated
| Before you mark the PR ready for review, please make sure that: | ||
| - [ ] The PR title is in the form of of `<PR type>: <#issue number> <area>: <change being made>` | ||
| - example: ` fix: #1234 mempool: Introduce a cache for valid signatures` | ||
| - `PR type`: _fix_, _feat_, _BREAKING CHANGE_, _build_, _chore_, _ci_, _docs_, _perf_, _refactor_, _revert_, _style_, _test_ |
There was a problem hiding this comment.
Not sure what a BREAKING CHANGE would count as
ZenGround0
approved these changes
Dec 13, 2021
|
interface breaking change (api, cli and others) |
jennijuju
commented
Dec 17, 2021
jennijuju
commented
Dec 17, 2021
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.
This is the very first iteration of the lotus PR template. The goal of adding PR template is to standardize PR requests and encourage contributors to:
The PR type follows the https://www.conventionalcommits.org/en/v1.0.0-beta.2/.
The contribution guideline should be updated with how to create a pr after the template is accepted.