github.com/saymoon/flop@v0.1.6-0.20201205092451-00912199cc96/CONTRIBUTING.md (about) 1 # Contributions Welcome 2 3 First off, thank you for considering contributing to this repository! This resource is a very simple project, but has plenty of room for improvement. 4 5 If you're just looking for quick feedback for an idea or proposal, feel free to open an 6 [issue](https://github.com/homedepot/flop/issues/new). 7 8 Follow the [contribution workflow](#contribution-workflow) for submitting your 9 changes. If you want to receive high-level but still 10 commit-based feedback for a contribution, follow the 11 [request for comments](#request-for-comments) steps instead. 12 13 ## Contribution Workflow 14 15 This project uses the “fork-and-pull” development model. Follow these steps if 16 you want to merge your changes into the project: 17 18 1. Within your fork of 19 [flop](https://github.com/homedepot/flop), create a 20 branch for your contribution. Use a meaningful name. 21 1. Create your contribution, meeting all 22 [contribution quality standards](#contribution-quality-standards) 23 1. [Create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) 24 against the master branch. 25 1. Once the pull request is approved, one of the maintainers will merge it. 26 27 ## Contribution Quality Standards 28 29 Your contribution needs to meet the following standards: 30 31 - Separate each **logical change** into its own commit. 32 - Add a descriptive message for each commit. Follow 33 [commit message best practices](https://github.com/erlang/otp/wiki/writing-good-commit-messages). 34 - Document your pull requests. Include the reasoning behind each change, and 35 the testing done. 36 - To the extent possible, follow existing code and documentation style and practices. 37