Files
CHOMPStation2/.github/CONTRIBUTING.md
2016-06-01 09:53:46 -04:00

2.3 KiB

Contributing to VOREStation

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to VOREStation, which is hosted in the VOREStation Org on GitHub. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Table Of Contents

What should I know before I get started?

How Can I Contribute?

Licensing

What should I know before I get started?

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Your First Code Contribution

Unsure where to begin contributing to VOREStation? You can start by looking through these beginner and help-wanted issues:

  • [Beginner issues][beginner] - issues which should only require a few lines of code, and a test or two.
  • [Help wanted issues][help-wanted] - issues which should be a bit more involved than beginner issues.

Pull Requests

  • Your submission must pass Travis CI checking. If you think there is a bug in Travis, open an issue.
  • It can be a WIP PR, and if so, please mark it with [WIP] in the title so it can be labeled appropriately.
  • If your pull request has many no-conflict merge commits, it cannot be merged. Squash and make a new PR.

Git Commit Messages

  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally.

Licensing

VOREStation is licensed under the GNU Affero General Public License version 3, which can be found in full in LICENSE-AGPL3.txt.

Commits with a git authorship date prior to 1420675200 +0000 (2015/01/08 00:00) are licensed under the GNU General Public License version 3, which can be found in full in LICENSE-GPL3.txt.

All commits whose authorship dates are not prior to 1420675200 +0000 are assumed to be licensed under AGPL v3, if you wish to license under GPL v3 please make this clear in the commit message and any added files.