2020-08-18 23:19:10 +02:00
## Contributing
Thanks for wanting to contribute to Taskcafe!
### Where do I go from here?
2020-09-02 22:32:37 +02:00
So you want to contribute to Taskcafe? Great!
2020-12-25 03:18:20 +01:00
If you have noticed a bug, please [create an issue ](https://github.com/JordanKnott/taskcafe/issues/new/choose ) for it before starting any work on a pull request.
If there is a [new feature you'd like added ](https://github.com/JordanKnott/taskcafe/discussions/new?category=ideas ) or [have a question ](https://github.com/JordanKnott/taskcafe/discussions/new?category=q-a ), please visit the [discussions section ](https://github.com/JordanKnott/taskcafe/discussions )
2020-09-02 22:32:37 +02:00
2020-09-10 22:57:53 +02:00
Alternatively you can join the [Taskcafe discord ](https://discord.gg/JkQDruh ) and ask in the #questions channel.
2020-09-02 22:32:37 +02:00
After the bug is validated or the feature is accepted by a project maintainer, the next step is to fork the repository!
2020-08-18 23:19:10 +02:00
### Fork & create a branch
If there is something you want to fix or add, the first step is to fork this repository.
Next is to create a new branch with an appropriate name. The general format that should be used is
```
git checkout -b '< type > /< description > '
```
The `type` is the same as the `type` that you will use for [your commit message ](https://www.conventionalcommits.org/en/v1.0.0/#summary ).
The `description` is a decriptive summary of the change the PR will make.
### General Rules
- All PRs should be rebased (with master) and commits squashed prior to the final merge process
2020-08-18 23:34:31 +02:00
- One PR per fix or feature
2020-08-21 01:17:07 +02:00
- Setup & install [pre-commit hooks ](https://pre-commit.com/#install ) then install the hooks `pre-commit install && pre-commit install --hook-type commit-msg`
2020-08-18 23:19:10 +02:00
2020-10-01 07:55:59 +02:00
### Unwanted PRs
- Please do not submit pull requests containing only typo fixes, fixed spelling mistakes, or minor wording changes.
2020-08-18 23:19:10 +02:00
### Git Commit Message Style
This project uses the [conventional commits ](https://www.conventionalcommits.org/en/v1.0.0/#summary ) format.
Example commit messages:
```
chore: update gqlgen dependency to v2.6.0
docs(README): add new contributing section
fix: remove debug log statements
```
