Skip to content
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

Jump to bottom

Establish CONTRIBUTING.md #12360

Closed
BigLep opened this issue Aug 8, 2024 · 1 comment · Fixed by #12366
Closed

Establish CONTRIBUTING.md #12360

BigLep opened this issue Aug 8, 2024 · 1 comment · Fixed by #12366
Assignees
@BigLep
Milestone
DX-Streamline

Comments

@BigLep
Copy link
Member

BigLep commented Aug 8, 2024 •
edited
Loading

Done Criteria

There is a CONTRIBUTING.md doc that consolidates contributing expectations in one place.

Why Important

  1. This is an open source norm; there's no reason to deviate.
  2. Right now we have expectations scattered across multiple places (e.g., README, PR templates, CI checks). It's good to have hooks in multiple places, but they should point back to one place (level of indirection) so contributors have one main place to read and maintainers have one main place to update/curate.

User/Customer

Contributors and Maintainers

Notes

To make sure this doesn't stay open indefinitely, I think we can close it when we have removed relevant content out of:

  1. README
  2. templates and workflows in https://github.com/filecoin-project/lotus/tree/master/.github
@BigLep BigLep added this to the DX-Streamline milestone Aug 8, 2024
@BigLep BigLep self-assigned this Aug 8, 2024
@BigLep BigLep added this to FilOz Aug 8, 2024
BigLep added a commit that referenced this issue Aug 8, 2024
@BigLep
docs: seed CONTRIBUTING.md pr title and changelog expectations
bdb7e5c 
This starts on #12360 as part of landing #12340
This was referenced Aug 8, 2024
Merged
Merged
@BigLep
Copy link
Member Author

BigLep commented Aug 8, 2024

This has gotten started in #12361

Once that lands, we can do a followup to move info out of README and then close this.

@BigLep BigLep moved this to ⌨️In Progress in FilOz Aug 8, 2024
BigLep added a commit that referenced this issue Aug 8, 2024
@BigLep @rjan90
docs: seed CONTRIBUTING.md with pr title and changelog expectations (#…
7292875 
…12361)

This starts on #12360 as part of landing #12340

* Update .github/workflows/pr-title-check.yml

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

---------

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>
rjan90 added a commit that referenced this issue Aug 9, 2024
@rjan90 @rvagg @BigLep
feat(ci): add PR title check workflow (#12340)
7530136 
* 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 <rod@vagg.org>

* 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 <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

---------

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update .github/workflows/pr-title-check.yml

Co-authored-by: Steve Loeppky <biglep@protocol.ai>

---------

Co-authored-by: Rod Vagg <rod@vagg.org>
Co-authored-by: Steve Loeppky <biglep@protocol.ai>
@rjan90 rjan90 mentioned this issue Aug 9, 2024
Merged
8 tasks
rjan90 added a commit to hanabi1224/lotus that referenced this issue Aug 12, 2024
@rjan90 @rvagg @BigLep
feat(ci): add PR title check workflow (filecoin-project#12340)
308b344 
* 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 <rod@vagg.org>

* 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 <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

---------

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update .github/workflows/pr-title-check.yml

Co-authored-by: Steve Loeppky <biglep@protocol.ai>

---------

Co-authored-by: Rod Vagg <rod@vagg.org>
Co-authored-by: Steve Loeppky <biglep@protocol.ai>
rjan90 added a commit that referenced this issue Aug 12, 2024
@rjan90 @rvagg @BigLep
feat(ci): add PR title check workflow (#12340)
33851e9 
* 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 <rod@vagg.org>

* 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 <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

---------

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update .github/workflows/pr-title-check.yml

Co-authored-by: Steve Loeppky <biglep@protocol.ai>

---------

Co-authored-by: Rod Vagg <rod@vagg.org>
Co-authored-by: Steve Loeppky <biglep@protocol.ai>
@rjan90 rjan90 moved this from ⌨️In Progress to 🎉 Done in FilOz Aug 13, 2024
@rjan90 rjan90 moved this from 🎉 Done to ☑️Done (Archive) in FilOz Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@BigLep BigLep

Labels
None yet
Projects
FilOz
Status: ☑️ Done (Archive)
Milestone
DX-Streamline
Development

Successfully merging a pull request may close this issue.

docs: expand CONTRIBUTING.md and update README.md filecoin-project/lotus
1 participant
@BigLep