Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

31 lines (23 loc) · 1.54 KB
Raw

Contributing to YEGRB.com

We love and appreciate any and all contributions to help us keep YEGRB.com useful and up-to-date! Whether it's to report a bug, directly address an open issue, or submit a completely new fix or improvement you identified on your own, we'd be happy to help you help us.

Making a Pull Request

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes. ($ rails test)
  4. Ensure your code follows our enforced style. ($ rubocop)
  5. 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.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • 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)

License

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