Contributing

Here we explain how you can help improve caskade! Perhaps you noticed an odd behaviour/bug, perhaps there is just a feature you’d like to see available, this is how to make it happen!

1 Make an Issue

Before doing any coding yourself, you should create an issue on the GitHub. To do this, first check that your issue doesn’t already exist, then write out as clearly as you can any relevant information. If this is a bug, you can include error traces, screenshots, code snippets, and so on to help us root down the problem. For completeness, its best to also include the caskade version you are using. If this is a feature request, you’ll need to describe the feature, maybe include some dummy code that shows what it would look like to with the feature, and give a clear description of what such a feature would be used for.

Discussion on the issue will whittle down the problem until we either solve it, or have a clear idea of what an update would look like.

2 Doing it Yourself

Lets say the issue has gone to the point that you want to try implementing it yourself. Here is how you get your own framework set up:

1. Fork the repo on GitHub

2. Clone your version of the repo to your machine: git clone git@github.com:YourGitHubName/caskade.git

3. Move into the caksade git repo: cd caksade

4. Install the editable development version: pip install -e .[dev]

5. Make a new branch: git checkout -b mynewbranch

6. Write up your new feature/fix

7. Write some tests in the tests/ directory

8. Check the tests run by calling pytest

9. Commit the changes (really you should do this often while working): git commit -m "my note on updates"

10. Push your changes back to GitHub: git push origin mynewbranch

11. Create a Pull Request on GitHub pointing to the original caskade repo

12. Watch the automated tests run and follow any discussion that happens on the PR!