Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 1.78 KB

Contributing

Thank you for your interest in contributing to the RCOS Observatory! Please read the following guidelines before opening an issue or pull request.

Hooks

There are 2 git hooks as part of this project:

  1. Before every commit cargo fmt is run to clean up code.
  2. Before every push cargo check is run to verify that the code compiles correctly.

These are to ensure that the project maintains code quality.

Conduct

Please conduct yourself in a respectful and professional manner. For more details please see the offical Code of Conduct in the RCOS Handbook

Style

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.

Documentation

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.

License

The RCOS Observatory is licensed under the permissive MIT license which is included in the LICSNSE file or can be read online here

All contributions to the Observatory are subject to the terms of this license. Any contributions under a different license must explicitly say so and may not be accepted if there is a conflict of interest.