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.

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: expand CONTRIBUTING.md and update README.md #12366

Merged
merged 3 commits into from
Aug 9, 2024

Conversation

rjan90
Copy link
Contributor

@rjan90 rjan90 commented Aug 9, 2024

Related Issues

Closes: #12360

Proposed Changes

  • Expanded CONTRIBUTING.md with detailed guidelines that was previously in README.md
  • Removed the detailed contribution guidelines in README.md and instead link to the CONTRIBUTING.md
  • Update links in pull_request_template.md

Checklist

Before you mark the PR ready for review, please make sure that:

rjan90 added 2 commits August 9, 2024 11:20
- Expanded CONTRIBUTING.md with detailed guidelines
- Updated README.md
docs: fix links in pull_request_template.md
@rjan90 rjan90 added the skip/changelog This change does not require CHANGELOG.md update label Aug 9, 2024
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rjan90 rjan90 requested a review from BigLep August 9, 2024 09:36
@rjan90 rjan90 changed the title docs: Expand CONTRIBUTING.md and update README.md docs: expand CONTRIBUTING.md and update README.md Aug 9, 2024
@github-actions github-actions bot dismissed their stale review August 9, 2024 09:39

PR title now matches the required format.

Copy link
Member

@BigLep BigLep left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sweet - thanks for taking this on!
This is also where I think we can capture soon our stance on commit types as well.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
Co-authored-by: Steve Loeppky <biglep@protocol.ai>
@rjan90 rjan90 merged commit eb6da32 into master Aug 9, 2024
84 checks passed
@rjan90 rjan90 deleted the phi/readme-to-contributions branch August 9, 2024 16:38
BigLep added a commit that referenced this pull request Aug 9, 2024
BigLep added a commit that referenced this pull request Aug 12, 2024
#12372)

* docs: updating CONTRIBUTING.md with table of contents and TOC guidance

This is followup to #12366 (comment)

* 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 to hanabi1224/lotus that referenced this pull request Aug 12, 2024
…ct#12366)

* docs: Expand CONTRIBUTING.md

- Expanded CONTRIBUTING.md with detailed guidelines
- Updated README.md

* docs: fix links in pull_request_template.md

docs: fix links in pull_request_template.md

* Update CONTRIBUTING.md

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

---------

Co-authored-by: Steve Loeppky <biglep@protocol.ai>
rjan90 added a commit to hanabi1224/lotus that referenced this pull request Aug 12, 2024
filecoin-project#12372)

* docs: updating CONTRIBUTING.md with table of contents and TOC guidance

This is followup to filecoin-project#12366 (comment)

* 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 pull request Aug 12, 2024
* docs: Expand CONTRIBUTING.md

- Expanded CONTRIBUTING.md with detailed guidelines
- Updated README.md

* docs: fix links in pull_request_template.md

docs: fix links in pull_request_template.md

* Update CONTRIBUTING.md

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

---------

Co-authored-by: Steve Loeppky <biglep@protocol.ai>
rjan90 added a commit that referenced this pull request Aug 12, 2024
#12372)

* docs: updating CONTRIBUTING.md with table of contents and TOC guidance

This is followup to #12366 (comment)

* Update CONTRIBUTING.md

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

---------

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip/changelog This change does not require CHANGELOG.md update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Establish CONTRIBUTING.md
2 participants