Skip to content
This repository has been archived by the owner on May 23, 2023. It is now read-only.

Latest commit

 

History

History
25 lines (20 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

25 lines (20 loc) · 1.75 KB

Contributing

Want to contribute to Clouds? Please do!

Contributions to this repo should take a "common-sense" approach. Follow a formal process. Before building anything, open an issue so that we can discuss what value your work will bring to Clouds.

Discussion & Documentation

I want to... Solution
Report a bug Open an issue and use the "Bug report" template
Submit my design work Open an issue and use the "Design improvement" template
Request a new feature or improvement Open an issue and use the "Feature request" template
Ask questions or gain context Open an issue and choose the blank demplate

Your Contributions

Any contributions you make will be licensed under the same MIT License that covers this project. When creating a new Swift source file, adjust the copyright in the header to match your name. Follow the same conventions as other source files already in the project.

Basic Code Style

  • 4 spaces for indentation in Swift, no tabs!
  • Keep your lines short. If you need to scroll to see an entire line of code, it's time to break it up.
  • Follow the documentation in the Wiki.

How Not to Contribute

  • Don't contribute code that adds no significant value.
  • If you don't add tests, the chances of your work getting merged drops from 100% to 10%. Write tests!
  • If your code breaks something, or breaks any existing tests, it can't be merged unless you fix the issue.