Skip to content

Commit

Permalink
Merge pull request #820 from Xiao75896453/fix/docs_contributing
Browse files Browse the repository at this point in the history
docs(docs): modify the wrong content in contributing md
  • Loading branch information
woile authored Aug 20, 2023
2 parents 854d29d + 120d514 commit 3a3667c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If you're a first-time contributor, you can check the issues with [good first is
(We use [CodeCov](https://codecov.io/) to ensure our test coverage does not drop.)
7. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit. We follow [conventional commits][conventional-commits]
8. Run `./scripts/format` and `./scripts/test` to ensure you follow the coding style and the tests pass.
9. Optionally, update the `README.md`.
9. Optionally, update the `./docs/README.md`.
9. **Do not** update the `CHANGELOG.md`, it will be automatically created after merging to `master`.
10. **Do not** update the versions in the project, they will be automatically updated.
10. If your changes are about documentation. Run `poetry run mkdocs serve` to serve documentation locally and check whether there is any warning or error.
Expand Down

0 comments on commit 3a3667c

Please sign in to comment.