Commit Graph

16 Commits

Author SHA1 Message Date
Benjamin Woodruff 0cfc85ceae Clarify AI-assisted contribution policy in PR template and AGENTS.md (#95629)
## Summary

Documents the policy around AI-assisted contributions, for both humans
and agents:

- `.github/pull_request_template.md`: notes that AI use is encouraged
for researching, creating, and reviewing changes, but contributors must
deeply understand their contributions, and PR descriptions from external
contributors must be written by a human.
- `.github/ISSUE_TEMPLATE/1.bug_report.yml`: adds the equivalent note
for bug reports — issue descriptions from external contributors must be
written by a human, though AI may help create reproductions.
- `AGENTS.md`: replaces the old "PR Descriptions" section with two new
sections. "GitHub Pull Requests" distinguishes branch PRs (agents may
write descriptions) from fork PRs targeting `vercel/next.js` (agents may
not). "GitHub Issues, Comments, and Discussions" restricts agent-written
issues, discussions, and comments to members of the
`vercel`/`vercel-labs` GitHub orgs, tells agents how to check membership
via the GitHub API, lists what agents can still help non-members with
(drafting details, reviewing, reproductions, translation, searching for
duplicates), and carves out exceptions (commenting on the user's own PR,
Vercel-operated bots, GitHub/Graphite review bots, and forks of the
repo).
- Renames the LLM watermark marker from `NEXT_JS_LLM_PR` to
`NEXT_JS_LLM` everywhere it appears (`AGENTS.md`,
`contributing/repository/pull-request-descriptions.md`, and the
`create-pr`/`backport-pr` skills), since it now also applies to issues,
discussions, and comments. Nothing in the repo consumes the old marker
name.
- `.agents/skills/create-pr/SKILL.md`: adds a "Fork PRs vs Branch PRs"
section referencing the `AGENTS.md` policy. Assorted typo fixes along
the way.

## Verification

- `gh api /user/memberships/orgs` and `gh api
orgs/vercel/members/<login>` (confirmed the documented membership checks
work and return the documented statuses)
- Not run: no test/build commands (docs-only change; prettier applied
via the pre-commit hook)

<!-- NEXT_JS_LLM -->
2026-07-10 11:27:52 -07:00
Jimmy Lai 4167e1f135 Docs: add signed commit guidance (#93155)
## What?

Adds contributor-facing guidance for the new signed-commit requirement.

- adds a `Signed commits` section to `contributing.md`
- adds a short signed-commit note to the PR template
- clarifies that a `Signed-off-by` line is not enough

## Why?

As signed commits become required, contributors need a clear explanation
in the repo and at PR time so they know what will be enforced and how to
recover from unsigned commits.

## How?

Documents the requirement in the main contribution guide and repeats the
key action items in the PR checklist.

## Testing

- docs-only change
- verified with local readback and diff review

<!-- NEXT_JS_LLM_PR -->
2026-04-23 09:04:54 -07:00
우혁 8f7790ab47 docs: remove removed examples guidelines reference from PR template (#83043)
## For Maintainers

### What?

Removed the references to the now-deleted examples guidelines from the
PR template. Specifically, removed the line about

```
The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
``` 
since that file and folder were deleted in PR
[#77050](https://github.com/vercel/next.js/pull/77050).

### Why?

The `/examples` folder and its `adding-examples.md` file were removed,
so the reference in the PR template to those guidelines is outdated and
misleading. Keeping those references causes confusion for contributors
by pointing to non-existent documentation.

### How?

- Edited the PR template file.
- Removed the outdated examples guidelines reference line.
- Left other template content unchanged to preserve existing guidance.

This ensures the PR template stays accurate, up-to-date, and helpful for
contributors.

---------

Co-authored-by: Joseph <joseph.chamochumbi@vercel.com>
2025-09-02 18:15:42 +02:00
Siddharth Gaikwad 56eeedff30 Update pull_request_template.md (#55098)
just added the ")" to the documentation
2023-09-08 00:19:49 +00:00
Delba de Oliveira e048f4ef03 [Docs] Recommend prettier-fix in PR template and contribution guide (#51237)
Recommend running `prettier-fix` before opening docs PRs to fix formatting issues. I've found that `lint-fix` is currently not fixing formatting issues. Related: https://vercel.slack.com/archives/C03S9JCH2Q5/p1686647582580629
2023-06-13 14:54:06 +00:00
Delba de Oliveira f6ff2ef98e [Next Docs] Update Git Workflow (#50579)
Update our git workflow in preparation for open-sourcing the content of
the docs ([linear
task](https://linear.app/vercel/issue/DX-1579/set-up-github-workflow)).

**Templates:**
- [x] Update docs issue template to encourage contributions
- [x] Update PR template to include link to new contribution guide 

**Code Owners / Reviewers:** 
- https://github.com/vercel/next.js/pull/50841

**Labels:** 
- [x] Add DevEx team to labeler.json so PRs get the "created by: DevEx
team"

**Other:** 
- [x] Remove docs manifest from CI checks as we no longer have one (keep
the manifest for errors as they live under `/pages`)
- [x] Add `unifiedjs.vscode-mdx` to the vscode extension list
2023-06-08 12:01:55 +02:00
Balázs Orbán f1fba5b456 chore: improve PR labeling, fix, sort, add new team member (#46675)
## What?

This PR has its main goal to improve the experience of opening/reviewing
a PR.

It improves the PR template, as well as extends PR auto-labeling.


## Why?

There are 2 parts to the PR template:

- Individual contributors: The current template accommodates for the
most common cases individual contributors use to contribute. (I.e.
fixing bugs, updating/adding examples, addressing documentation issues).
The new template keeps this at the top.
- Next.js team: As maintainers, we should try to explain PRs as if
someone with less context would review them. This should also help with
backreferencing PRs in issues and follow-up PRs and make it easier to
follow changes, understand trade-offs better at the time, and help new
team members catch up over time, etc.

## How?

The template is written in a comment instead of Markdown, so when the PR
is opened, most of the template is hidden to make it less verbose.

The checkboxes we've had before are not shown, but we already auto-label
PRs based on the path of the files that have been touched, so the
checkboxes showed redundant information.


[Slack
thread](https://vercel.slack.com/archives/C04DUD7EB1B/p1677677802109289),
Closes NEXT-741
2023-03-07 10:54:46 +01:00
vinay a47841b0ac Some changes in grammar (#45467)
## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/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`
- [ ] [e2e](https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm build && pnpm lint`
- [ ] The "examples guidelines" are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
2023-02-01 09:06:59 +00:00
Jan Kaifer a2df178554 Add links to PR template (#43239) 2022-11-22 16:12:35 +01:00
Jim Cresswell 0cb17627a8 docs: clarify PR template instructions (#41957)
Running "pnpm lint" on a documentation change won't work unless "pnpm
build" has previously been run, e.g. on a fresh checkout of a fork after
clicking the published docs "edit this on GitHub" button.

## Documentation / Examples

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

Co-authored-by: JJ Kasper <jj@jjsweb.site>
Co-authored-by: Steven <steven@ceriously.com>
2022-10-27 15:04:50 -07:00
Balázs Orbán 3ff21ed178 refactor: split up CONTRIBUTING.md (#40515)
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>
2022-09-16 14:54:58 -07:00
JJ Kasper f7b81316ae Update to leverage pnpm for monorepo (#37259)
* Update to leverage pnpm for monorepo

* update compiled

* update stats action

* update ci install step

* update ci

* add test dep

* update invoking scripts

* update caching

* skip cache for now

* update dep

* update packages and fix babel

* update compiled

* update lint

* update test

* update ci

* update pnpm store caching

* update path for windows

* update restore-key config

* update caching

* remove extra build azure stage

* re-add checkout

* update setting pnpm store

* bump

* remove azure caching as pnpm is faster to download

* update contributing

* apply suggestions

* remove install-peers

* prepublish -> prepublishOnly

* prepublish -> prepublishOnly more

* more yarn -> pnpm references

* more yarn -> pnpm references take 2

* use workspace protocol for root package.json

Co-authored-by: Steven <steven@ceriously.com>
2022-05-28 23:35:16 -05:00
JJ Kasper 7206614d0b Update contributing doc and PR template for examples (#37193)
* Update contributing doc and PR template for examples

* Apply suggestions from code review

Co-authored-by: Steven <steven@ceriously.com>
2022-05-25 20:24:53 -05:00
Katie Byers 58a79e34e5 add linting instructions (#30123) 2021-10-20 21:52:23 -05:00
Tim Neutkens 59c742ee7f Add instructions on how to add nextjs.org/docs/messages urls (#26865)
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2021-07-02 13:39:00 +02:00
Tim Neutkens 3caf6420d0 Add PR template 2021-03-19 09:59:26 +01:00