From ada9c3e71d6ebf42e6959e19c6ad4c1238739ffd Mon Sep 17 00:00:00 2001 From: Kevin Nielsen Date: Mon, 25 Dec 2023 19:07:52 +0100 Subject: [PATCH] [Documentation] Add commit convention to contribution docs (#60) * docs: add commit-convention to contribution guide --- .../content/docs/contribution/contributing.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/src/content/docs/contribution/contributing.md b/docs/src/content/docs/contribution/contributing.md index 9b3de7a..c8f4647 100644 --- a/docs/src/content/docs/contribution/contributing.md +++ b/docs/src/content/docs/contribution/contributing.md @@ -13,6 +13,34 @@ If you want to report a bug or request a feature, you can go ahead and create a Please read the [Development Guide](/go-fast-cdn/contribution/development) to learn more about how to develop on this project. +### Commits + +This project follows the [@commitlint convention](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) and we ask that you please do the same as much as possible. The most important thing is to add a commit-type which should be one of the following: + +- **build** - changes regarding the build +- **chore** - changes not covered by other types +- **ci** - changes regarding CI/CD +- **docs** - changes regarding docs +- **feat** - new features +- **fix** - bug fixes +- **perf** - changes enhancing performance +- **refactor** - refactoring code +- **revert** - reverting to earlier commits +- **style** - changes regarding style +- **test** - changes regarding testing + +An example of a commit message following this convention could be + +```txt +docs: add commit-convention to contribution guide +``` + +To further specify what your commit is changing, you can add a scope with parentheses, like this: + +```txt +feat(api): add endpoint for file uploads +``` + ## Documentation [Github](https://github.com/kevinanielsen/go-fast-cdn/) Is a monorepo, where the documentation can be found in the /docs directory. If you want to request documentation for a feature, go ahead and create a new issue on Github, if you have the solution for an issue or want to edit the documentation, go ahead and fork the project, and when you are ready, open a new pull request.