Skip to content

Commit

Permalink
Merge pull request #121 from MacPaw/ingvarus-bc-patch-1
Browse files Browse the repository at this point in the history
Create CONTRIBUTING.md
  • Loading branch information
ingvarus-bc authored Nov 14, 2023
2 parents 0085055 + d7fb335 commit fcadae0
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Contribution Guidelines
Make your Pull Requests clear and obvious to anyone viewing them.
Set `main` as your target branch.

#### Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) principles in naming PRs and branches:

- `Feat: ...` for new features and new functionality implementations.
- `Bug: ...` for bug fixes.
- `Fix: ...` for minor issues fixing, like typos or inaccuracies in code.
- `Chore: ...` for boring stuff like code polishing, refactoring, deprecation fixing etc.

PR naming example: `Feat: Add Threads API handling` or `Bug: Fix message result duplication`

Branch naming example: `feat/add-threads-API-handling` or `bug/fix-message-result-duplication`

#### Write description to pull requests in following format:
- What

...
- Why

...
- Affected Areas

...
- More Info

...

We'll appreciate you including tests to your code if it is needed and possible. ❤️

0 comments on commit fcadae0

Please sign in to comment.