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