How to Contribute

We welcome contributions from anybody! There are various ways you can contribute. For example, you can introduce new code, you can improve the documentation, or you can contribute new examples. Development takes place on GitHub. So you can look for open issues and open pull requests there.

We also welcome GitHub issues that report errors of any kind (whether its code bugs, errors in the documentation, or just a comments about things that you think are missing from the documentation).

If you are interested in contributing, you may want to get in touch, just so we can make sure that multiple people are not duplicating efforts.

Licensing

Cholla is distributed under the MIT license. Consequently, all contributed code must also use the same license (or at least be compatible).

How to actually contribute?

Cholla development makes use of Git and GitHub. If you aren’t familiar with these tools, we recommend that you read some of the excellent guides provided by GitHub.

All Cholla code is generally formatted. But, please don’t be intimidated by that. The repository is configured so that you don’t need to install anything on your machine. Our Code Formatting Guide provides more guidance.