Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 1.91 KB

CONTRIBUTING.rst

File metadata and controls

71 lines (45 loc) · 1.91 KB

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/jancami/edibles/issues.

If you are reporting a bug, please include:

  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

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

Implement Features

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

Write Documentation

astro_scripts_uibk could always use more documentation, whether as part of the official astro_scripts_uibk docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/jancami/edibles/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 :)

  1. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    flake8 edibles
coverage run -m pytest

    To get flake8, just pip install it into your virtualenv.

  2. Commit your changes and push your branch to GitLab:

    git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

    When pushing your commit, the tests are automatically run on gitlab.

  3. Submit a pull request or merge request with master through the GitLab website.