Skip to content

Commit

Permalink
docs: add contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
kffl committed Jul 31, 2022
1 parent fb779b7 commit 6c9dc70
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Contributing to speedbump

## Bugs and feature requests (Issues)

1. If you have found a bug, please check existing Issues prior to opening a new one.
2. When reporting a bug via issues, please provide commit # (or output of `speedbump --version` if you are using a pre-built binary form a GitHub release).
3. A bug report should include accurate description of the steps required to reproduce it.
4. Feature requests are welcome!

## Pull requests

### Commit naming

This project uses [conventional commits](https://www.conventionalcommits.org/).

### WIP changes

If you encounter a problem while having work-in-progress changes in your repo, don't hesitate to open a draft pull request.

Thanks!

0 comments on commit 6c9dc70

Please sign in to comment.