Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

36 lines (25 loc) · 2.23 KB

Contributing

Thanks for your interest in contributing! This project follows our Gem guidelines.

Code of Conduct

We expect all participants to adhere to our Code of Conduct.

How Can I Contribute?

There are several ways to contribute to this project, including (but not limited to):

  • Reporting bugs
  • Requesting features
  • Responding to bug reports / feature requests
  • Submitting PR(s) that address issues labeled with "help wanted"
  • Updating documentation

Before making a contribution, search through the existing issues and pull requests to see if your item has already been raised or addressed. If there is an existing open issue that impacts you, it is best practice to upvote (👍) the initial comment as opposed to adding an additional comment voicing your support. The latter creates noise for the LaunchPad Lab team and makes it difficult for us to quickly and effectively rank issues according to the community's priority.

Getting Started Locally

  1. Fork and clone the repo
  2. Run bundle to install dependencies
  3. Run rspec to run unit tests
  4. Load development changes in a local application in your Gemfile 
    gem "decanter", path: "/path/to/repo"

Proposing a Change

For any non-trivial change, we prefer an issue to be created first. This helps us (and you!) save time and keep track of conversations and decisions made regarding the project.

Sending a Pull Request

If this is your first Pull Request, we recommend learning how to navigate GitHub via this free video tutorial: How to Contribute to an Open Source Project on GitHub.

The LaunchPad Lab team monitors this repository for pull requests. Once a pull request has been created from a forked repository that meets all the guidelines outlined in the Pull Request Checklist, we will review the request and either merge it, request changes, or close it with an explanation. We aim to respond to pull requests within 48 hours.