Bug reports, feature suggestions and other contributions are greatly appreciated! Sami2py is a community-driven project and welcomes both feedback and contributions.
Submit bug reports and feature requests through GitHub
Make pull requests to the
When `reporting a bug <https://github.com/sami2py/sami2py/issues>>`_ please include:
Your operating system name and version
Any details about your local setup that might be helpful in troubleshooting
Detailed steps to reproduce the bug
Feature requests and feedback¶
The best way to send feedback is to file an issue at GitHub.
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 code contributions are welcome :)
To set up
sami2py for local development:
Clone your fork locally
git clone email@example.com:your_name_here/sami2py.git
Create a branch for local development
git checkout -b name-of-your-bugfix-or-feature Now you can make your changes locally. Tests for new instruments are performed automatically. Tests for custom functions should be added to the appropriately named file in ``sami2py/tests``. If no test file exists, then you should create one. This testing uses pytest, which will run tests on any python file in the test directory that starts with ``test_``.
When you’re done making changes, run all the checks to ensure that nothing is broken on your local system. You may need to install pytest and pytest-flake8 first.
pytest -vs --flake8
Update/add documentation (in
docs), if relevant
Commit your changes and push your branch to GitHub
git add . git commit -m "Brief description of your changes" git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website. Pull requests should be made to the
Pull Request Guidelines¶
If you need some code review or feedback while you’re developing the code, just make a pull request.
For merging, you should:
Include an example for use
Add a note to
CHANGELOG.mdabout the changes
Ensure that all checks passed (current checks include Travis-CI and Coveralls) 1
If you don’t have all the necessary Python versions available locally or
have trouble building all the testing environments, you can rely on Travis to run the tests for each change you add in the pull request. Because testing here will delay tests by other developers, please ensure that the code passes all tests on your local system first.