Skip to content

Commit

Permalink
[Documentation] Add commit convention to contribution docs (#60)
Browse files Browse the repository at this point in the history
* docs: add commit-convention to contribution guide
  • Loading branch information
kevinanielsen authored Dec 25, 2023
1 parent 775de59 commit ada9c3e
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/src/content/docs/contribution/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit ada9c3e

Please sign in to comment.