Skip to main content

How to contribute

All sorts of contributions to this project! Here's how you can get involved:

  • Found a bug? Let us know! Open an issue and briefly describe the problem.
  • Have a great idea for a new feature? Open an issue to discuss it. If you'd like to implementing it yourself, you can assign this issue to yourself and create a pull request once the code/improvement/fix is ready.
  • Want to talk about something related to the project? Discussion threads are the perfect place to brainstorm ideas

Here is how you could add your new code/improvement/fix with a pull request:

  1. Fork the repository (e.g., latest changes must be in develop branch)
    git clone -b develop https://github.com/dmarro89/dare-db
  2. Create a new branch for your feature. Use number of a newly created issue and keywords (e.g., 10-implement-feature-ABC)
    git checkout -b 10-implement-feature-ABC
  3. Add changes to the branch
    git add .
  4. Commit your changes
    git commit -am 'add new feature ABC'
  5. Push to the branch
    git push origin 10-implement-feature-ABC
  6. Open a pull request based on a new branch
  7. Provide a short notice in the pull request according to the following template:
    • Added: ...
    • Changed: ...
    • Fixed: ...
    • Dependencies: ...