Skip to content
This repository has been archived by the owner on Apr 1, 2021. It is now read-only.

Latest commit

 

History

History
19 lines (9 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

19 lines (9 loc) · 1.14 KB
Raw

Contributing

Code Style

  • This project uses rubocop. Get it with gem install rubocop and then run rubocop --auto-correct inside the git repo to fix all formating problems automatically. More sever code style violations may need some manual attention. PR's without rubocop applied are not being merged.

    Rubocop Style Reference: https://rubocop.readthedocs.io/en/latest/cops_style/

  • Fasterer is a tool that will suggest speed improvements for your ruby code. It is highly recommended to use on bigger changes to keep the Canuby code fast. Get it with gem install fasterer and then run fasterer inside the git repo to get the code flash fast. Note Currently not working correctly for unknown reasons.

Testing

To run the Canuby tests use rake test in the root directory.

Documenting

Canuby uses yardoc to generate the docs. They are available here GitHub Downloads. To update the documentation manually run rake yard. Travis updates the online documentation automatically.