Skip to content

Commit 5e3a94b

Browse files
chore: update CONTRIBUTING.md (#12511)
- I corrected the use of `yarn` instead of `pnpm` - I corrected the URL for previewing the documentation (it was missing `/local`). - I removed the incorrect section about what type of commit falls into the release notes. --------- Co-authored-by: Jacob Fletcher <[email protected]>
1 parent 3670886 commit 5e3a94b

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -87,41 +87,43 @@ You can run the entire test suite using `pnpm test`. If you wish to only run e2e
8787

8888
By default, `pnpm test:int` will only run int test against MongoDB. To run int tests against postgres, you can use `pnpm test:int:postgres`. You will have to have postgres installed on your system for this to work.
8989

90-
### Commits
90+
### Pull Requests
9191

92-
We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for our commit messages. Please follow this format when creating commits. Here are some examples:
92+
For all Pull Requests, you should be extremely descriptive about both your problem and proposed solution. If there are any affected open or closed issues, please leave the issue number in your PR description.
9393

94-
- `feat: adds new feature`
95-
- `fix: fixes bug`
96-
- `docs: adds documentation`
97-
- `chore: does chore`
94+
All commits within a PR are squashed when merged, using the PR title as the commit message. For that reason, please use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for your PR titles.
9895

99-
Here's a breakdown of the format. At the top-level, we use the following types to categorize our commits:
96+
Here are some examples:
10097

101-
- `feat`: new feature that adds functionality. These are automatically added to the changelog when creating new releases.
102-
- `fix`: a fix to an existing feature. These are automatically added to the changelog when creating new releases.
103-
- `docs`: changes to [docs](./docs) only. These do not appear in the changelog.
104-
- `chore`: changes to code that is neither a fix nor a feature (e.g. refactoring, adding tests, etc.). These do not appear in the changelog.
98+
- `feat: add new feature`
99+
- `fix: fix bug`
100+
- `docs: add documentation`
101+
- `test: add/fix tests`
102+
- `refactor: refactor code`
103+
- `chore: anything that does not fit into the above categories`
104+
105+
If applicable, you must indicate the affected packages in parentheses to "scope" the changes. Changes to the payload chore package do not require scoping.
106+
107+
Here are some examples:
108+
109+
- `feat(ui): add new feature`
110+
- `fix(richtext-lexical): fix bug`
105111

106112
If you are committing to [templates](./templates) or [examples](./examples), use the `chore` type with the proper scope, like this:
107113

108114
- `chore(templates): adds feature to template`
109115
- `chore(examples): fixes bug in example`
110116

111-
## Pull Requests
112-
113-
For all Pull Requests, you should be extremely descriptive about both your problem and proposed solution. If there are any affected open or closed issues, please leave the issue number in your PR message.
114-
115117
## Previewing docs
116118

117119
This is how you can preview changes you made locally to the docs:
118120

119121
1. Clone our [website repository](https://github.com/payloadcms/website)
120-
2. Run `yarn install`
122+
2. Run `pnpm install`
121123
3. Duplicate the `.env.example` file and rename it to `.env`
122124
4. Add a `DOCS_DIR` environment variable to the `.env` file which points to the absolute path of your modified docs folder. For example `DOCS_DIR=/Users/yourname/Documents/GitHub/payload/docs`
123-
5. Run `yarn run fetchDocs:local`. If this was successful, you should see no error messages and the following output: _Docs successfully written to /.../website/src/app/docs.json_. There could be error messages if you have incorrect markdown in your local docs folder. In this case, it will tell you how you can fix it
124-
6. You're done! Now you can start the website locally using `yarn run dev` and preview the docs under [http://localhost:3000/docs/](http://localhost:3000/docs/)
125+
5. Run `pnpm fetchDocs:local`. If this was successful, you should see no error messages and the following output: _Docs successfully written to /.../website/src/app/docs.json_. There could be error messages if you have incorrect markdown in your local docs folder. In this case, it will tell you how you can fix it
126+
6. You're done! Now you can start the website locally using `pnpm dev` and preview the docs under [http://localhost:3000/docs/local](http://localhost:3000/docs/local)
125127

126128
## Internationalization (i18n)
127129

0 commit comments

Comments
 (0)