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

Refactor contributing guide #39778

Closed
wants to merge 13 commits into from
Closed

Refactor contributing guide #39778

wants to merge 13 commits into from

Conversation

timneutkens
Copy link
Member

Splits contributing guide into a directory with multiple files that are linked from the main contributing.md file.

  • Added additional details on linting.
  • Added explanation of stable vs canary channel and how to publish them for maintainers.
  • Added explanation on how a version is decided.
  • Changed recommendation for fork workflow to use GitHub CLI instead.
  • Changed testing recommendation to always be headless + narrow down the run. Changed command to pnpm test to simplify.
  • Added "why" and "the fix" for pnpm new-error, also added logging of the error url at the end of the command.

Bug

  • Related issues linked using fixes #number
  • Integration tests added
  • Errors have helpful link attached, see contributing.md

Feature

  • Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
  • Related issues linked using fixes #number
  • Integration tests added
  • Documentation added
  • Telemetry added. In case of a feature if it's used or not.
  • Errors have helpful link attached, see contributing.md

Documentation / Examples

  • Make sure the linting passes by running pnpm lint
  • The examples guidelines are followed from our contributing doc

@timneutkens timneutkens marked this pull request as draft August 20, 2022 12:59
This was referenced Sep 13, 2022
Closed
Merged
@balazsorban44
Copy link
Member

Closing in favor of #40515. All comments will be addressed there. Will mark it as ready for review when it is ready. 🙏

balazsorban44 added a commit that referenced this pull request Sep 13, 2022
@balazsorban44
mention pnpm next
89afdef 
#39778 (comment)
balazsorban44 added a commit that referenced this pull request Sep 13, 2022
@balazsorban44
stable -> canary
21a7614 
Ref: #39778 (comment)
ijjk added a commit that referenced this pull request Sep 16, 2022
@balazsorban44 @timneutkens @ijjk
refactor: split up CONTRIBUTING.md (#40515)
3ff21ed 
Continues #39778

Closes #40499

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the
feature request has been accepted for implementation before opening a
PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have helpful link attached, see `contributing.md`

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm lint`
- [ ] The examples guidelines are followed from [our contributing
doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)

Co-authored-by: Tim Neutkens <tim@timneutkens.nl>
Co-authored-by: JJ Kasper <jj@jjsweb.site>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@balazsorban44 balazsorban44 balazsorban44 left review comments

@ijjk ijjk ijjk left review comments

@hanneslund hanneslund hanneslund left review comments

@theoludwig theoludwig theoludwig left review comments

@SukkaW SukkaW SukkaW left review comments

@shuding shuding Awaiting requested review from shuding shuding is a code owner

@huozhi huozhi Awaiting requested review from huozhi huozhi is a code owner

@feedthejim feedthejim Awaiting requested review from feedthejim feedthejim will be requested when the pull request is marked ready for review feedthejim is a code owner

@ztanner ztanner Awaiting requested review from ztanner ztanner will be requested when the pull request is marked ready for review ztanner is a code owner

@wyattjoh wyattjoh Awaiting requested review from wyattjoh wyattjoh will be requested when the pull request is marked ready for review wyattjoh is a code owner

Assignees
No one assigned
Labels
created-by: Next.js team PRs by the Next.js team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@timneutkens @balazsorban44 @ijjk @hanneslund @theoludwig @SukkaW