Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 2.44 KB
Raw

Awesome Suricata Contributing Guide

The goal of this document is to create a contribution process that:

  • Encourages new contributions.
  • Encourages contributors to remain involved.

Logging Issues

Log an issue for any question or problem you might have. When in doubt, log an issue, and any additional policies about what to include will be provided in the responses. Please be courteous and respectful. Every participant is expected to follow the Code of Conduct.

Adding something to an awesome list

You can fork repository, create new branch and then creat pull request from github ui.

Otherwise you can do that more easily with next steps.

You'll need a GitHub account!

  1. Access the awesome list's GitHub page. For example: https://github.com/satta/awesome-suricata
  2. Click on the README.md
  3. Now click on the edit icon.
  4. You can start editing the text of the file in the in-browser editor. You can use GitHub Flavored Markdown.
  5. Say why you're proposing the changes, and then click on "Propose file change".
  6. Submit the pull request!

Sending Pull Requests

Ensure your pull request adheres to the following guidelines:

  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Make an individual pull request for each suggestion.
  • Use title-casing (AP style).
  • Use the following format: [Title Case Name](link) - Description.
  • Keep descriptions short and simple, but descriptive.
  • Start the description with a capital and end with a full stop/period.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.
  • New categories or improvements to the existing categorization are welcome.
  • Pull requests should have a useful title.
  • The body of your commit message should contain a link to the repository.

Thank you for your suggestion!

Updating your PR

A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. There's no need to open a new PR, just edit the existing one. If you're not sure how to do that, here is a guide on the different ways you can update your PR so that we can merge it.