Skip to content

Latest commit

 

History

History
151 lines (94 loc) · 4.31 KB

CONTRIBUTING.md

File metadata and controls

151 lines (94 loc) · 4.31 KB
Raw

Contributing to the Sunrise Choir

Thanks for your interest in contributing to the Sunrise Choir! 🌅 🙏 🎶

This project is open commons that anyone can improve, stewarded by the Sunrise Choir team. 😺

We welcome all contributions, such as but not limited to:

  • designs
  • specifications
  • documentation
  • tests
  • websites
  • artwork
  • code

Table Of Contents

Code of Coundect

Anyone who interacts with the Sunrise Choir in any space, including but not limited to our GitHub repositories, must follow our Code of Conduct.

What should I know before I get started?

TODO

Sunrise Choir ecosystem

TODO

Sunrise Choir design decisions

TODO

How can I contribute?

Bug reports

Have a look at the issue tracker for the relevant repository. If you can't find an issue (open or closed) describing your problem (or a very similar one) there, please open a new issue with the following details:

  • Which versions are you using?
  • What are you trying to accomplish?
  • What is the full error you are seeing?
  • How can we reproduce this?
    • Please quote as much of your code as needed to reproduce (best link to a public repository or Gist

Thank you! We'll try to respond as quickly as possible.

Feature requests

If you can't find an issue (open or closed) describing your idea, open an issue. Adding answers to the following questions in your description is helpful:

  • What do you want to do, and how do you expect the Sunrise Choir to support you with that?
  • How might this be added to the Sunrise Choir?
  • What are possible alternatives?
  • Are there any disadvantages?

Thank you! We'll try to respond as quickly as possible.

Licensing

We prefer to license libraries under the LGPL-3.0 license, apps under the MPL-2.0 license, and documentation / specifications under the CC-BY 4.0 license.

Code contributions

Please be sure to follow the relevant Style Guides.

Style Guide

Git commit messages

TODO

Rust style guide

We follow the Rust Style Guide, enforced using rustfmt.

To run rustfmt tests locally:

  1. Use rustup to set rust toolchain to the version specified in the repository's rust-toolchain file.

  2. Install the rustfmt and clippy by running

rustup component add rustfmt
rustup component add clippy
  1. Run clippy using cargo from the root of your repo.
cargo clippy

Each Pull Request needs to compile without warning.

  1. Run rustfmt using cargo from the root of your repo

To see changes that need to be made, run

cargo fmt --all -- --check

If all code is properly formatted (e.g. if you have not made any changes), this should run without error or output.

If your code needs to be reformatted, you will see a diff between your code and properly formatted code. If you see code here that you didn't make any changes to then you are probably running the wrong version of rustfmt.

Once you are ready to apply the formatting changes, run

cargo fmt --all

You won't see any output, but all your files will be corrected.

JavaScript style guide

We follow the JavaScript Standard Style, enforced using standard.

Specs style guide

We use Markdown for our specifications.

TODO

Documentation style guide

We use Markdown for our documentation.

TODO

Additional Notes

TODO