Skip to content
This repository has been archived by the owner on Jul 12, 2020. It is now read-only.

Latest commit

 

History

History
42 lines (32 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

42 lines (32 loc) · 1.92 KB
Raw

Contributing to Transcriptase

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. Make sure you run bundle install && rails db:create && rails db:migrate
  3. If you've added code that should be tested, add tests.
  4. If you've changed APIs, update the documentation.
  5. Ensure the test suite passes.
  6. Make sure your code does not generate rubocop errors or warnings
  7. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Write great issue reports

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Use a Consistent Coding Style

Refer to the following: [Rails Style Guide] (https://github.com/bbatsov/rails-style-guide) [Ruby Style Guide] (https://github.com/bbatsov/ruby-style-guide)

Also, make sure all rubocop errors are resolved. There is a rubocop config file in the project directory which is set up accordingly.

License

By contributing, you agree that your contributions will be licensed under its MIT License.