Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

37 lines (27 loc) · 1.62 KB
Raw

Contributions Welcome

First off, thank you for considering contributing to this repository! This resource is a very simple project, but has plenty of room for improvement.

If you're just looking for quick feedback for an idea or proposal, feel free to open an issue.

Follow the contribution workflow for submitting your changes. If you want to receive high-level but still commit-based feedback for a contribution, follow the request for comments steps instead.

Contribution Workflow

This project uses the “fork-and-pull” development model. Follow these steps if you want to merge your changes into the project:

  1. Within your fork of flop, create a branch for your contribution. Use a meaningful name.
  2. Create your contribution, meeting all contribution quality standards
  3. Create a pull request against the master branch.
  4. Once the pull request is approved, one of the maintainers will merge it.

Contribution Quality Standards

Your contribution needs to meet the following standards:

  • Separate each logical change into its own commit.
  • Add a descriptive message for each commit. Follow commit message best practices.
  • Document your pull requests. Include the reasoning behind each change, and the testing done.
  • To the extent possible, follow existing code and documentation style and practices.