Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

devguide: discuss backports and other updates - v3 #10056

Closed

Conversation

jufajardini
Copy link
Contributor

Link to redmine ticket:
https://redmine.openinfosecfoundation.org/issues/6568

Previous PR: #9914

Describe changes:

  • incorporate feedbacks from last PR
  • adjust the suggestions for documentation changes: these should be in their dedicated commits, but reference the code change related ticket in the commit message. I still fear this won't be enough for preventing us missing commits, but not sure this is easily avoidable - has happened with code commits in the past, so I guess this is more of something for us to be mindful of during our review processes... Maybe a checklist item? No commits missed from last version ?

Result can be seen at: https://suri-rtd-test.readthedocs.io/en/contribution-docs-updates-v3/devguide/contributing/backports-guide.html

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.
This section seemed to aim both at PR reviewers and PR authors at the
same time, even though some info is probably of low value for
contributors.

Created new section for PR reviewers and maintainers, and kept the info
for PR authors separated. Also highlighted information on requested
changes and stale PRs.
If a commit introduces code that changes Suricata behavior, the related
documentation changes should go in a separate commit, but refer to the
same ticket number.
This reduces the chances of said changes being lost if there are backports
while still keeping the backporting process a bit less bulky, for each
commit.

Related to
Task OISF#6568
Update the list of active branches to include 7 renaming and new master,
link to backports document.
Sphinx and RtD sometimes render lists in weird ways. The communication
channels list barely looked like one, at all...
@victorjulien victorjulien added this to the 8.0 milestone Jan 2, 2024
This was referenced Jan 2, 2024
@victorjulien
Copy link
Member

Merged in #10115, thanks!

@jufajardini jufajardini deleted the contribution-docs-updates/v3 branch January 5, 2024 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
3 participants