Contributing

Bug reports are greatly appreciated! Requests for larger changes will likely take place on a longer timescale.&

Short version

• Submit bug reports and feature requests at GitHub <https://github.com/aburrell/lstid_processing/issues>_

• Make pull requests to the develop branch

Bug reports

When reporting a bug <https://github.com/aburrell/lstid_processing/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 <https://github.com/aburrell/lstid_processing/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 code contributions are welcome :)

Development

To set up lstid_processing for local development:

1. Fork lstid_processing on GitHub <https://github.com/aburrell/lstid_processing/fork>_.

2. Clone your fork locally::

   git clone git@github.com:your_name_here/lstid_processing.git

3. Create a branch for local development::

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

   Now you can make your changes locally.

4. When you’re done making changes, run the tests locally before submitting a pull request

5. 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

6. Submit a pull request through the GitHub website. Pull requests should be made to the develop branch.

Pull Request Guidelines

If you need some code review or feedback while you’re developing the code, just make a pull request.

Do not merge any pull requests, the local maintainer is in charge of merging until this project grows.