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

chore(docs): fix setup steps in contributing doc #1478

Merged
merged 2 commits into from
Jun 1, 2023

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

The PR updates the contributing docs by clarifying that prospective contributors should be using [email protected] instead of 8.x like previously stated.

The change is needed because the 9.x version comes bundled with the Node.js version used by the project.

Additionally, as housekeeping item, the PR also removes a redundant { target="_blank" } notation in a link that was present in all README files.

Once merged, this PR closes #1477.

Related issues, RFCs

Issue number: #1477

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@boring-cyborg boring-cyborg bot added the internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) label Jun 1, 2023
@pull-request-size pull-request-size bot added the size/L PRs between 100-499 LOC label Jun 1, 2023
@dreamorosi dreamorosi self-assigned this Jun 1, 2023
@dreamorosi dreamorosi merged commit 12284e9 into main Jun 1, 2023
@dreamorosi dreamorosi deleted the dreamorosi/issue1477 branch June 1, 2023 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) size/L PRs between 100-499 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: contributing - setup instructions
1 participant