Skip to content

Commit

Permalink
chore(contributing): add CONTRIBUTING guide
Browse files Browse the repository at this point in the history
  • Loading branch information
chubchubsancho committed Sep 12, 2022
1 parent 937538e commit f300a5a
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# How to Contribute

## Pull Requests

Repository use the [GitHub flow](https://guides.github.com/introduction/flow/) as main versioning workflow

1. Fork the repository
2. Create a new branch for each feature, fix or improvement
3. Keep your git history as clean as possible
4. Send a pull request from each feature branch to the **master** branch

It is very important to separate new features or improvements into separate feature branches, and to send a
pull request for each branch.

This allow us to review and pull in new features or improvements individually.

## Style Guide

All pull requests SHOULD adhere to the [Conventional Commits specification](https://conventionalcommits.org/)

## License

You must agree that your patch will be licensed under the MIT License, and when we change the license we will assume that you agreed with the change unless you object to the changes in time.

0 comments on commit f300a5a

Please sign in to comment.