Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 1.5 KB

CONTRIBUTING.rst

File metadata and controls

58 lines (35 loc) · 1.5 KB
Raw

Contributing

Contributions are welcome indeed!

Report bugs or request features

Report bugs at https://github.com/GeraldJansen/hamster-lite/issues.

If you are reporting a bug, please include:

  • Detailed steps to reproduce the bug.
  • Output of hamster-lite version or git describe --tags --always --dirty=+.

Please remember to check both open and closed issues to see if the issue has already been reported.

Write Documentation

Like most software, hamster-lite could always use better documentation. Minor corrections or additions can be performed using the github editing functions online. For larger contributions please fork, clone and prepare a pull request.

Fix bugs or implement features

Ready to contribute? Here's how to set up hamster-lite for local development.

  1. Fork the hamster-lite repo on GitHub.

  2. Clone your fork locally:

    $ git clone [email protected]:your_name_here/hamster-lite.git

  3. Create a branch for local development:

    $ cd hamster-lite/
$ git checkout -b name-of-branch

    Now you can make your changes locally.

  4. When you're done making changes, check that your changes don't break existing tests.

    $ python3 tests/stuff_test.py

  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-branch

  2. Submit a pull request through the GitHub website.