|
| 1 | +# How to contribute |
| 2 | + |
| 3 | +:+1::tada: First off, thanks for taking the time to contribute! :tada::+1: |
| 4 | + |
| 5 | +It's people like you that make security open source such a force in preventing |
| 6 | +successful cyber-attacks. Following these guidelines helps keep the project |
| 7 | +maintainable, easy to contribute to, and more secure. Thank you for taking the |
| 8 | +time to follow this guide. |
| 9 | + |
| 10 | +## Where to start |
| 11 | + |
| 12 | +There are many ways to contribute. You can fix a bug, improve the documentation, |
| 13 | +submit bug reports and feature requests, or take a first shot at a feature you |
| 14 | +need for yourself. |
| 15 | + |
| 16 | +Pull requests are necessary for all contributions of code or documentation. |
| 17 | + |
| 18 | +## New to open source? |
| 19 | + |
| 20 | +If you're **new to open source** and not sure what a pull request is, welcome!! |
| 21 | +We're glad to have you! All of us once had a contribution to make and didn't |
| 22 | +know where to start. |
| 23 | + |
| 24 | +Even if you don't write code for your job, don't worry, the skills you learn |
| 25 | +during your first contribution to open source can be applied in so many ways, |
| 26 | +you'll wonder what you ever did before you had this knowledge. It's worth |
| 27 | +learning. |
| 28 | + |
| 29 | +[Learn how to make a pull request](https://github.com/PaloAltoNetworks/.github/blob/master/Learn-GitHub.md#learn-how-to-make-a-pull-request) |
| 30 | + |
| 31 | +## Fixing a typo, or a one or two line fix |
| 32 | + |
| 33 | +Many fixes require little effort or review, such as: |
| 34 | + |
| 35 | +> - Spelling / grammar, typos, white space and formatting changes |
| 36 | +> - Comment clean up |
| 37 | +> - Change logging messages or debugging output |
| 38 | +
|
| 39 | +These small changes can be made directly in GitHub if you like. |
| 40 | + |
| 41 | +Click the pencil icon in GitHub above the file to edit the file directly in |
| 42 | +GitHub. This will automatically create a fork and pull request with the change. |
| 43 | +See: |
| 44 | +[Make a small change with a Pull Request](https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github/) |
| 45 | + |
| 46 | +## Bug fixes and features |
| 47 | + |
| 48 | +For something that is bigger than a one or two line fix, go through the process |
| 49 | +of making a fork and pull request yourself: |
| 50 | + |
| 51 | +> 1. Create your own fork of the code |
| 52 | +> 2. Clone the fork locally |
| 53 | +> 3. Make the changes in your local clone |
| 54 | +> 4. Push the changes from local to your fork |
| 55 | +> 5. Create a pull request to pull the changes from your fork back into the |
| 56 | +> upstream repository |
| 57 | +
|
| 58 | +Please use clear commit messages so we can understand what each commit does. |
| 59 | +We'll review every PR and might offer feedback or request changes before |
| 60 | +merging. |
0 commit comments