Skip to content

Latest commit

 

History

History
35 lines (29 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

35 lines (29 loc) · 1.54 KB

Contributing

If you discover issues, have ideas for improvements or new features, please report them to the issue tracker of the repository or submit a pull request. Please, try to follow these guidelines when you do so.

Issue reporting

  • Check that the issue has not already been reported.
  • Check that the issue has not already been fixed.
  • Be clear, concise and precise in your description of the problem.
  • Include Ruby, RSpecTracer, and RSpec version. Also include Simplecov version if applicable.

Pull requests

  • Read how to properly contribute to open source projects on GitHub.
  • Fork the project.
  • Write good commit messages.
  • Use the same coding conventions as the rest of the project.
  • If your change has a corresponding open GitHub issue, prefix the commit message with [Fix #github-issue-number].
  • Make sure to add tests for it.
  • Make sure to run bundle exec rake assets:precompile in lib/rspec_tracer/html_reporter if changing JavaScript and CSS files.
  • Make sure to run bundle exec rake.
  • Squash related commits together.
  • Open a pull request that relates to only one subject with a clear title and description in grammatically correct, complete sentences.