Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

68 lines (43 loc) · 2.39 KB

Contributing to Moistpetal

Moistpetal is an open source project.

Current moistpetal status is Pre-Alpha(AF) but we're committed to continued and active development. It is the work of many contributors. We appreciate your help!

Before filing an issue

Feel free to ask about any issues in the moistpetal mailing list. If you've discovered something not already raised then please submit a new issue to track progress.

Filing issues

When filing an issue, make sure to answer these five questions:

  1. What version of Moistpetal are you using?
  2. What operating system and processor architecture are you using?
  3. What did you do?
  4. What did you expect to see?
  5. What did you see instead?

Sensitive security-related issues should be reported to [email protected].

Getting Started

  • Make sure you have a GitHub account.
  • File an issue, assuming one does not already exist.
  • Clearly describe the issue including steps to reproduce when it is a bug.
  • Fork the repository on GitHub.

Making Changes

  • Create a topic branch from where you want to base your work.
  • This is usually the master branch.
  • To quickly create a topic branch based on master; git checkout -b fix/master/my_contribution master. Please avoid working directly on the master branch.
  • Make commits of logical units.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure your commit messages are accurate and meaningful.
  • Make sure you have added the necessary tests for your changes.
  • Run all the tests to assure nothing else was accidentally broken.

Submitting Changes

  • Sign the Contributor License Agreement.
  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the official repository.
  • The authors look at pull requests on a regular weekly basis.
  • After feedback is given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

LICENSE

Unless otherwise noted, all source files are distributed under the Apache-2.0 license found in the LICENSE file.