-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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.
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
docs: seed CONTRIBUTING.md with pr title and changelog expectations #12361
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed a couple of typos and replaced #
with //
for comments in the pr-title-check.yml
file. The #
comments were invalid in JavaScript, causing the check to fail.
After those has been applied, this PR should be fine to merge into the phi/PR-title-check
branch, and then we can continue to land your suggestion: #12340
Co-authored-by: Phi-rjan <[email protected]>
Co-authored-by: Phi-rjan <[email protected]>
Co-authored-by: Phi-rjan <[email protected]>
Co-authored-by: Phi-rjan <[email protected]>
* Add PR title check workflow Add PR title check workflow Add colon Add colon Request change to PR title instead of blocking PR Request change to PR title instead of blocking PR Remove change requested if title conforms to the formate Remove change requested if title conforms to the formate * fix: workflow: Ensure PR title check posts review comments fix: workflow: Ensure PR title check posts review comments * Add fail if title is invalid Add fail if title is invalid * fix: workflow: Ensure PR title check fails for invalid titles fix: workflow: Ensure PR title check fails for invalid titles * refactor: pr-title-check: Streamline workflow and reduce complexity refactor: pr-title-check: Streamline workflow and reduce complexity * Update allowed PR-types pattern Update allowed PR-types pattern * Update pr-title-check.yml Co-authored-by: Rod Vagg <[email protected]> * Use conventional commit, but allow for legacy - Allow optional "[skip changelog]" prefix - Both <type>: <scope>: and <type>(<scope>): formats - Use conventional commit "scope" instead of area - Alphabetize <type> and <scope> * docs: update pull_request_template.md Adjust pull_request_template.md according to the changes introduced with the PR title check workflow * fix(ci): update regex to support both PR title formats fix(ci): update regex to support both PR title formats * docs: seed CONTRIBUTING.md with pr title and changelog expectations (#12361) This starts on #12360 as part of landing #12340 * Update .github/workflows/pr-title-check.yml Co-authored-by: Phi-rjan <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Phi-rjan <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Phi-rjan <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Phi-rjan <[email protected]> --------- Co-authored-by: Phi-rjan <[email protected]> * Update .github/workflows/pr-title-check.yml Co-authored-by: Steve Loeppky <[email protected]> --------- Co-authored-by: Rod Vagg <[email protected]> Co-authored-by: Steve Loeppky <[email protected]>
* Add PR title check workflow Add PR title check workflow Add colon Add colon Request change to PR title instead of blocking PR Request change to PR title instead of blocking PR Remove change requested if title conforms to the formate Remove change requested if title conforms to the formate * fix: workflow: Ensure PR title check posts review comments fix: workflow: Ensure PR title check posts review comments * Add fail if title is invalid Add fail if title is invalid * fix: workflow: Ensure PR title check fails for invalid titles fix: workflow: Ensure PR title check fails for invalid titles * refactor: pr-title-check: Streamline workflow and reduce complexity refactor: pr-title-check: Streamline workflow and reduce complexity * Update allowed PR-types pattern Update allowed PR-types pattern * Update pr-title-check.yml Co-authored-by: Rod Vagg <[email protected]> * Use conventional commit, but allow for legacy - Allow optional "[skip changelog]" prefix - Both <type>: <scope>: and <type>(<scope>): formats - Use conventional commit "scope" instead of area - Alphabetize <type> and <scope> * docs: update pull_request_template.md Adjust pull_request_template.md according to the changes introduced with the PR title check workflow * fix(ci): update regex to support both PR title formats fix(ci): update regex to support both PR title formats * docs: seed CONTRIBUTING.md with pr title and changelog expectations (filecoin-project#12361) This starts on filecoin-project#12360 as part of landing filecoin-project#12340 * Update .github/workflows/pr-title-check.yml Co-authored-by: Phi-rjan <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Phi-rjan <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Phi-rjan <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Phi-rjan <[email protected]> --------- Co-authored-by: Phi-rjan <[email protected]> * Update .github/workflows/pr-title-check.yml Co-authored-by: Steve Loeppky <[email protected]> --------- Co-authored-by: Rod Vagg <[email protected]> Co-authored-by: Steve Loeppky <[email protected]>
* Add PR title check workflow Add PR title check workflow Add colon Add colon Request change to PR title instead of blocking PR Request change to PR title instead of blocking PR Remove change requested if title conforms to the formate Remove change requested if title conforms to the formate * fix: workflow: Ensure PR title check posts review comments fix: workflow: Ensure PR title check posts review comments * Add fail if title is invalid Add fail if title is invalid * fix: workflow: Ensure PR title check fails for invalid titles fix: workflow: Ensure PR title check fails for invalid titles * refactor: pr-title-check: Streamline workflow and reduce complexity refactor: pr-title-check: Streamline workflow and reduce complexity * Update allowed PR-types pattern Update allowed PR-types pattern * Update pr-title-check.yml Co-authored-by: Rod Vagg <[email protected]> * Use conventional commit, but allow for legacy - Allow optional "[skip changelog]" prefix - Both <type>: <scope>: and <type>(<scope>): formats - Use conventional commit "scope" instead of area - Alphabetize <type> and <scope> * docs: update pull_request_template.md Adjust pull_request_template.md according to the changes introduced with the PR title check workflow * fix(ci): update regex to support both PR title formats fix(ci): update regex to support both PR title formats * docs: seed CONTRIBUTING.md with pr title and changelog expectations (#12361) This starts on #12360 as part of landing #12340 * Update .github/workflows/pr-title-check.yml Co-authored-by: Phi-rjan <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Phi-rjan <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Phi-rjan <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Phi-rjan <[email protected]> --------- Co-authored-by: Phi-rjan <[email protected]> * Update .github/workflows/pr-title-check.yml Co-authored-by: Steve Loeppky <[email protected]> --------- Co-authored-by: Rod Vagg <[email protected]> Co-authored-by: Steve Loeppky <[email protected]>
This starts on #12360 as part of landing #12340