Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (39 loc) · 3.46 KB

CONTRIBUTING.md

File metadata and controls

64 lines (39 loc) · 3.46 KB

Contributing

First off, thank you for considering contributing to Cloud Posse! It's people like you that make our community great.

Code of Conduct

Cloud Posse has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

What Should I Know Before I Get Started?

Cloud Posse Projects

Each Cloud Posse project is hosted in its own repository on GitHub. Before contributing, familiarize yourself with the specific project you are interested in. Each repository typically contains a README.md with an overview of the project, and instructions for setting up your development environment and running tests.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before creating bug reports, please check the Github Issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out issue template as the information it asks for helps us resolve issues faster.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Cloud Posse, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.

Your First Code Contribution

Unsure where to begin contributing to Cloud Posse? You can start by looking through issues with the following labels:

Label Usage
help-wanted issues which should only require a few lines of code, and a test or two.
beginner issues which should be a bit more involved than issues.

Pull Requests

The process described here has several goals:

  • Maintain Cloud Posse's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible Cloud Posse
  • Enable a sustainable system for Cloud Posse's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow all instructions in Pull Request template
  2. Follow the styleguides
  3. After you submit your pull request, verify that all status checks are passing
  4. If you need to request a review on your PR, please do so in the #pr-reviews Slack channel

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move resource to..." not "Moves resource to...")
  • Limit the first line to 72 characters or less

Pull Requests

  • Reference GitHub Issues and Pull Requests liberally in a ## References section.
  • Use Closes #1234 to indicate when a PR fixes an issue.