Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

58 lines (42 loc) · 2.33 KB
Raw

How to contribute

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

It's people like you that make security open source such a force in preventing successful cyber-attacks. Following these guidelines helps keep the project maintainable, easy to contribute to, and more secure. Thank you for taking the time to follow this guide.

Where to start

There are many ways to contribute. You can fix a bug, improve the documentation, submit bug reports and feature requests, or take a first shot at a feature you need for yourself.

Pull requests are necessary for all contributions of code or documentation.

New to open source?

If you're new to open source and not sure what a pull request is, welcome!! We're glad to have you! All of us once had a contribution to make and didn't know where to start.

Even if you don't write code for your job, don't worry, the skills you learn during your first contribution to open source can be applied in so many ways, you'll wonder what you ever did before you had this knowledge. It's worth learning.

Learn how to make a pull request

Fixing a typo, or a one or two line fix

Many fixes require little effort or review, such as:

  • Spelling / grammar, typos, white space and formatting changes
  • Comment clean up
  • Change logging messages or debugging output These small changes can be made directly in GitHub if you like.

Click the pencil icon in GitHub above the file to edit the file directly in GitHub. This will automatically create a fork and pull request with the change. See: Make a small change with a Pull Request

Bug fixes and features

For something that is bigger than a one or two line fix, go through the process of making a fork and pull request yourself:

  1. Create your own fork of the code
  2. Clone the fork locally
  3. Make the changes in your local clone
  4. Push the changes from local to your fork
  5. Create a pull request to pull the changes from your fork back into the upstream repository Please use clear commit messages so we can understand what each commit does. We'll review every PR and might offer feedback or request changes before merging.