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:
Donate and/or Sponsor¶
You can see the instructions at https://chrissmejia.com/contribute/OpenSloth
Every dollar is really appreciated and helps me to keep coding quality OpenSource code, you are going to have your name at the honor list.
For sponsors there’s a special treatment, your logo will be featured on the site, and your name included at the source code.
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.
Look through the GitHub issues for bugs. Anything tagged with bug is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with feature is open to whoever wants to implement it.
The documentation is included in the OpenSloth repository, please consider to add more documentation.
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 :)
Ready to contribute? Here’s how to set up OpenSloth.
Fork the OpenSloth repo on GitHub.
Clone your fork locally:
$ git clone firstname.lastname@example.org:your_name_here/OpenSloth.git
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
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
Submit a pull request through the GitHub website.