Commit graph

19 commits

Author SHA1 Message Date
Balázs Orbán
16a0e5af32
chore: improve repo templates (#46629)
## What?

- Rendering `next info` output as code in the bug template
- Removed the "Feature Request" issue template, in favor of a more
granular discussion template
- Added a minimal template for Help discussions

## Why?

The main part of this PR is the new Feature Request template.

Anyone can propose a change to Next.js. However adding new features
often requires community discussions - whether to align expectations,
understand the consequences (eg.: backward compatibility/lifetime of a
feature), to look at and understand historical reasons for the current
behavior or lack of the feature -, which [GitHub
discussions](https://github.com/vercel/next.js/discussions) is more
suited for than issues.

## How?

- Utilizing the new discussion templates
https://docs.github.com/en/discussions/managing-discussions-for-your-community/creating-discussion-category-forms
- Adding a link to the [new
issue](https://github.com/vercel/next.js/issues/new/choose) view to make
it easier to discover

[Slack
thread](https://vercel.slack.com/archives/C04DUD7EB1B/p1670874727319809)

Closes NEXT-742

---------
2023-03-01 09:25:51 -08:00
edward
c7f43e583d
Fix adding-exmaples.md doc (#46051)
<!--
Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:
-->

There are two edit point

First, The url in the doc directed wrong URL.

Second, The instruction in the doc says "Make sure linting passes (you
can run pnpm lint-fix)"
But PR request user to check "Make sure the linting passes by running
`pnpm build && pnpm lint`"
I thought that it need unity and if i run pnpm lint-fix, lots of errors
appear.
So i edit instruction from `pnpm lint-fix` to `pnpm build & pnpm lit`


## Documentation / Examples

- [x] Make sure the linting passes by running `pnpm build && 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>
2023-02-17 22:35:12 -08:00
Andrii Bodnar
e50dbc7d3c
docs: fix contributing guideline (#46005)
This PR fixes the json object example in the docs contributing
guidelines

## Documentation / Examples

- [x] Make sure the linting passes by running `pnpm build && 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>
2023-02-16 15:48:16 -08:00
Jan Kaifer
1c7f66c70b
Update testing.md to reflect that we don't use yarn anymore (#45185) 2023-01-23 14:41:42 -08:00
Wyatt Johnson
71efc03a50
Support Prefer Offline for testing (#44935) 2023-01-16 13:16:51 -08:00
Will Binns-Smith
d9eb29a9fa
Recommend next-with-deps for running examples (#44667)
Depends on https://github.com/vercel/next.js/pull/44666

This will install `package.json` dependencies in examples before running them.
2023-01-06 21:51:45 +00:00
BrandNewLifeJackie26
b0560399b0
docs: Update GitHub CLI clone command in developing.md (#44509)
Closes #44469



## Documentation / Examples

- [x] Make sure the linting passes by running `pnpm build && pnpm lint`
2023-01-03 00:07:59 +00:00
Jan Kaifer
f6cba806ad
Increase recommended git clone depth (#44181)
Follow-up in https://github.com/vercel/next.js/pull/44158/files#r1053100022
2022-12-20 09:53:36 +00:00
Jan Kaifer
60b8468b35
Suggest contributors to use shallow clone (#44158)
It will decrease the download size from `1.7GiB` to just `28MiB`.

Co-authored-by: JJ Kasper <22380829+ijjk@users.noreply.github.com>
2022-12-19 19:02:25 +00:00
Jan Kaifer
ab328c6c39
Add tracing for testing tools (#44046) 2022-12-16 09:58:04 +01:00
Jan Kaifer
367a5df546
Clarify e2e dependency on yarn in contributin docs (#43287)
`yarn` installed with `corepack` won't run in our repo because it is configured as a `pnpm` project. `yarn` binaries installed from other sources don't care.

## 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

- [x] 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)
2022-12-09 12:34:32 +00:00
Alpha
f355dd4f4f
[docs] Enhanced grammar in building README. (#42155)
Closes https://github.com/vercel/next.js/issues/42154

This PR enhances grammar in building README.
2022-10-29 22:02:24 -07:00
Alpha
c19c10069f
grammar fix in adding-examples README. (#42152)
Closes https://github.com/vercel/next.js/issues/42151

This PR fixes grammar in adding-examples README.
2022-10-29 22:02:08 -07:00
Alpha
0a0c8e0299
Enhanced grammar. (#42148)
closes  https://github.com/vercel/next.js/issues/42147

This PR enhances the grammar in adding-documentation README.
2022-10-30 04:59:24 +00:00
alpha-xek
c17e7cb525
[docs] Fix Grammar in Step 8. (#42018) 2022-10-27 16:29:05 -07:00
teobler
830750af30
docs: add tips for building first before running test for contribute Nextjs. (#41379)
close https://github.com/vercel/next.js/issues/41378

add tips for building first before running tests for contribute Nextjs

## Documentation / Examples

- [x] Make sure the linting passes by running `pnpm lint`
2022-10-13 03:45:08 +00:00
Balázs Orbán
4cb96fb047
chore(contributing): remove note about eslint-config-next
Since we don't prefer having ESLint as part of the examples anyway.
2022-09-30 00:59:13 +02:00
Trystan Rivers
26a23e98b0
chore/fix typo on contributing documentation (#41037)
Fixes #41038
2022-09-29 19:55:10 +00: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