Contributing

Thank you for your interest, contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Fix typos

I’m not native english speaker then I’m going to have tons of typos, if you find one, please fix it or report the issue.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with bug is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with feature is open to whoever wants to implement it.

Write Documentation

The documentation is included in the OpenSloth repository, please consider to add more documentation.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/chrissmejia/OpenSloth/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up OpenSloth.

  1. Fork the OpenSloth repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/OpenSloth.git
    
  3. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature
    

Now you can make your changes locally.

  1. Commit your changes and push your branch to GitHub:

    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature
    
  2. Submit a pull request through the GitHub website.