Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (27 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

45 lines (27 loc) · 1.67 KB
Raw

Code of Conduct

This project and everyone participating in it is governed by the Firespring Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@firespring.com.

How to contribute

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

Pull requests are always appreciated.

To get started contributing, fork and clone the repo:

git clone git@github.com:your-username/manifestly-ruby.git

Install development Gems:

bundle install

Make your code changes.

Make sure that your changes do not break any existing tests:

rspec spec/unit

Pull requests will not be accepted for any additional functionality without adding accompanying tests. Moreover, the repository contains a configuration for Rubocop. Pull requests will also not be accepted that do not pass the rubocop style-check. To check this simply run:

rubocop

Open a new GitHub pull request for the patch.

Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.