devguide: make 'contributing' a chapter

This could be justified from a semantic point of view, and also can help
in bringing more attention to where this information is, as it is less
hidden, now.

Also add Dev Guide as one of our resources in our Readme.
pull/10115/head
Juliana Fajardini 1 year ago committed by Victor Julien
parent f12e026696
commit 08eb67f74c

@ -2,7 +2,7 @@ Contributing to Suricata
========================
We're happily taking patches and other contributions. The process is documented at
[Contribution Process](https://docs.suricata.io/en/latest/devguide/codebase/contributing/contribution-process.html). Please have a look at this document before submitting.
[Contribution Process](https://docs.suricata.io/en/latest/devguide/contributing/contribution-process.html). Please have a look at this document before submitting.
Contribution Agreement
----------------------

@ -1,7 +1,7 @@
Make sure these boxes are signed before submitting your Pull Request -- thank you.
- [ ] I have read the contributing guide lines at
https://docs.suricata.io/en/latest/devguide/codebase/contributing/contribution-process.html
https://docs.suricata.io/en/latest/devguide/contributing/contribution-process.html
- [ ] I have signed the Open Information Security Foundation contribution agreement at
https://suricata.io/about/contribution-agreement/ (note: this is only required once)
- [ ] I have updated the user guide (in doc/userguide/) to reflect the changes made (if applicable)

@ -13,6 +13,7 @@ developed by the [OISF](https://oisf.net) and the Suricata community.
- [Home Page](https://suricata.io)
- [Bug Tracker](https://redmine.openinfosecfoundation.org/projects/suricata)
- [User Guide](https://docs.suricata.io)
- [Dev Guide](https://docs.suricata.io/en/latest/devguide/index.html)
- [Installation Guide](https://docs.suricata.io/en/latest/install.html)
- [User Support Forum](https://forum.suricata.io)
@ -20,7 +21,7 @@ developed by the [OISF](https://oisf.net) and the Suricata community.
We're happily taking patches and other contributions. Please see our
[Contribution
Process](https://docs.suricata.io/en/latest/devguide/codebase/contributing/contribution-process.html)
Process](https://docs.suricata.io/en/latest/devguide/contributing/contribution-process.html)
for how to get started.
Suricata is a complex piece of software dealing with mostly untrusted
@ -105,7 +106,7 @@ change, it will probably go into the next major version.
__Q: Why was my PR closed?__
A: As documented in the [Suricata GitHub
workflow](https://docs.suricata.io/en/latest/devguide/codebase/contributing/github-pr-workflow.html),
workflow](https://docs.suricata.io/en/latest/devguide/contributing/github-pr-workflow.html),
we expect a new pull request for every change.
Normally, the team (or community) will give feedback on a pull request

@ -4,7 +4,6 @@ Working with the Codebase
.. toctree::
:maxdepth: 2
contributing/index.rst
installation-from-git
code-style
fuzz-testing

@ -5,5 +5,6 @@ Suricata Developer Guide
:maxdepth: 2
codebase/index.rst
contributing/index.rst
internals/index.rst
extending/index.rst

@ -77,7 +77,7 @@ support is done by the core team. If someone wants to help maintain
and support such a feature, we recommend talking to the core team
before spending a lot of time on it.
Please see :doc:`devguide/codebase/contributing/contribution-process`
Please see :doc:`devguide/contributing/contribution-process`
for more information if you wish to contribute.
Distributions

Loading…
Cancel
Save