Thank you for your interest in contributing to the RCOS Observatory! Please read the following guidelines before opening an issue or pull request.
We use a "blessed repository" style of development, meaning no one is intended to push commits directly. Instead all contributions should follow the fork-and-pull method. This is common for GitHub and their guides on it are a great place to start https://guides.github.com/.
Please conduct yourself in a respectful and professional manner. For more details please see the offical RCOS Code of Conduct in the RCOS Handbook
Please ensure that any contributions follow good code style. We suggest running an auto-formatter on your code before submitting it.
For Rust we suggest using the official rustfmt tool to format to code.
For HTML and JavaScript there are a variety of acceptable tools, prettier
would be a good choice.
Project-level documentation can be found in the docs folder and contributions and improvements are greatly welcomed!
Any contributions to Observatory should be properly documented using the in-code RustDoc format. More information about how to do this can be found in the Rust Book here.
Please be descriptive in your documentation, it helps both you and us to understand your code better and really adds to maintainability. You don't have to write a book, but at least explain what the code does and why.
The RCOS Observatory is licensed under the permissive MIT license which is included in the LICSNSE file or can be read online here.
Non-code assets are licensed under the terms of the Creative Commons Attributions 4.0 International which is included in the COPYING file or can be read online here.
All contributions to the Observatory are subject to the terms of these license. Any contributions under a different license must explicitly say so and may not be accepted if there is a conflict of interest.