CONTRIBUTING.md

Contributing

This document is a set of guidelines for contributing to this repository.

Code of Conduct

This project follows a Code of Conduct in order to ensure an open and welcoming environment.

How to submit changes

1. Fork the repository to your personal Github. Forking is basically an easy way to make a duplicate of the repository to your own account.
2. Clone the project to your own machine.

   # Clone your fork of the repo into the current directory
   git clone https://github.com/<your-username>/<repo-name>
   # Navigate to the newly cloned directory
   cd <repo-name>
   # Assign the original repo to a remote called "upstream"
   git remote add upstream https://github.com/<upsteam-owner>/<repo-name>

3. If you cloned a while ago, get the latest changes from upstream.

   git checkout <dev-branch>
   git pull upstream <dev-branch>

4. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix.

   git checkout -b <topic-branch-name>

5. Commit changes to your own branch.

   git commit -m 'Add some feature'

6. Locally merge (or rebase) the upstream development branch into your topic branch.

   git pull [--rebase] upstream <dev-branch>

7. Push your topic branch up to your fork.

   git push origin <topic-branch-name>

8. Open a Pull Request with a clear title and description so that we can review your changes.

Thanks for your interest in contributing to this repository.