|
| 1 | +# How to contribute |
| 2 | +Contributions to Cake.Incubator are highly encouraged and desired. Below are some guidelines that will help make the process as smooth as possible. |
| 3 | + |
| 4 | +# Getting Started |
| 5 | +* Make sure you have a [GitHub account](https://github.com/signup/free) |
| 6 | +* Submit a new issue, assuming one does not already exist. |
| 7 | + * Clearly describe the issue including steps to reproduce when it is a bug. |
| 8 | + * Make sure you fill in the earliest version that you know has the issue. |
| 9 | +* Fork the repository on GitHub |
| 10 | + |
| 11 | +# Suggesting Enhancements |
| 12 | +We want to know what you think is missing from Cake.Incubator and how it can be made better. |
| 13 | +* When submitting an issue for an enhancement, please be as clear as possible about why you think the enhancement is needed and what the benefit of |
| 14 | +it would be. |
| 15 | + |
| 16 | +# Making Changes |
| 17 | +* From your fork of the repository, create a topic branch where work on your change will take place. |
| 18 | +* To quickly create a topic branch based on master; `git checkout -b my_contribution master`. Please avoid working directly on the `master` branch. |
| 19 | +* Make commits of logical units. |
| 20 | +* Check for unnecessary whitespace with `git diff --check` before committing. |
| 21 | +* Please follow the prevailing code conventions in the repository. Differences in style make the code harder to understand for everyone. |
| 22 | +* Make sure your commit messages are in the proper format. |
| 23 | +```` |
| 24 | + Add more cowbell to Get-Something.ps1 |
| 25 | +
|
| 26 | + The functionaly of Get-Something would be greatly improved if there was a little |
| 27 | + more 'pizzazz' added to it. I propose a cowbell. Adding more cowbell has been |
| 28 | + shown in studies to both increase one's mojo, and cement one's status |
| 29 | + as a rock legend. |
| 30 | +```` |
| 31 | + |
| 32 | +* Make sure you have added all the necessary Pester tests for your changes. |
| 33 | +* Run _all_ PESTER tests in the module to assure nothing else was accidentally broken. |
| 34 | + |
| 35 | +# Documentation |
| 36 | +We are infallible and as such the documenation needs no corectoin. In the highly |
| 37 | +unlikely event that that is _not_ the case, commits to update or add documentation |
| 38 | +are highly apprecaited. |
| 39 | + |
| 40 | +# Submitting Changes |
| 41 | +* Push your changes to a topic branch in your fork of the repository. |
| 42 | +* Submit a pull request to the main repository. |
| 43 | +* Once the pull request has been reviewed and accepted, it will be merged with the master branch. |
| 44 | +* Celebrate |
| 45 | + |
| 46 | +# Additional Resources |
| 47 | +* [General GitHub documentation](https://help.github.com/) |
| 48 | +* [GitHub forking documentation](https://guides.github.com/activities/forking/) |
| 49 | +* [GitHub pull request documentation](https://help.github.com/send-pull-requests/) |
| 50 | +* [GitHub Flow guide](https://guides.github.com/introduction/flow/) |
| 51 | +* [GitHub's guide to contributing to open source projects](https://guides.github.com/activities/contributing-to-open-source/) |
0 commit comments