Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

42 lines (31 loc) · 2.52 KB
Raw

Contributing to Slick-Cats

We want to make contributing to this project as easy and transparent as possible. There are a few guidelines we need contributors to follow so that we are able to process requests as efficiently as possible. If you have any questions or concerns, please contact one of the maintainers.

Getting Started

  • Make sure you have a GitHub account
  • Submit the RMS Contributor License Agreement
  • Submit a ticket for your issue, assuming one does not already exist.
  • Clearly describe the issue including steps to reproduce when it is a bug.
  • Make sure you fill in the earliest version that you know has the issue.
  • Fork the repository on GitHub

Making Changes

  • Create a topic branch off of master before you start your work.
  • Please avoid working directly on the master branch.
  • Make commits of logical units.
  • You may be asked to squash unnecessary commits down to logical units.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Write meaningful, descriptive commit messages.
  • Please follow existing code conventions when working on a file.

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the repository maintained by the RMS organization.
  • After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.
  • Bug fixes or features that lack appropriate tests may not be considered for merge.
  • Changes that lower test coverage may not be considered for merge.

Additional Resources

Contributor License Agreement ("CLA")

In order to accept your pull request, we need you to submit a RMS CLA. You only need to do this once to work on any of RMS's open source projects. If you are submitting a RMS CLA as an employee or contractor, ensure that you have obtained permission to enter into the CLA and submit contributions on behalf of your employer. The RMS CLA is based on the Apache Software Foundation's Individual Contributor License Agreement. Complete your CLA here

License

By contributing to Slick-Cats, you agree that your contributions will be licensed under the LICENSE file in the root directory of the Slick-Cats source tree.