rsyslog/rsyslog
1
0
Fork 0
mirror of https://github.com/rsyslog/rsyslog.git synced 2025-12-17 04:40:43 +01:00
Code Issues Packages Projects Releases Wiki Activity
rsyslog/.github/pull_request_template.md
Rainer Gerhards 97c7c68f5c
docs: streamline contrib templates and commit guidance 
This modernizes contributor experience by simplifying PR templates and
removing the lengthy GDPR disclaimer that often discouraged or confused
new contributors. The update encourages more participation and shows how
responsible AI can be used to improve open source workflows.

Impact: none on runtime behavior; contributor workflow improved.

Before: PR template included long GDPR block; commit message rules were
scattered and partly implicit.
After: PR template is concise, GDPR text removed, and commit assistant
usage is documented across README, CONTRIBUTING, and AGENTS.md.

Technical changes include:
- PR template: drop GDPR notice, add commit-assistant references.
- CONTRIBUTING.md: add explicit commit rules and workflow guidance.
- AGENTS.md: require canonical base prompt and commit-first workflow.
- README.md: point to assistant and updated guidance.
- base_prompt.txt: enforce "Findings:" colon format.
- Minor formatting corrections in comments.
2025-08-18 13:59:53 +02:00

1.6 KiB
Raw Blame History

Summary (non-technical, complete)

References

Refs: https://github.com/rsyslog/rsyslog/issues/

Notes (optional)

Quick check (optional)

  • Commit message follows rules (ASCII; title ≤62, body ≤72; <component>:).
  • Commit message includes non-technical “why”, Impact (if behavior/tests changed), and a one-line Before/After when behavior changed.
  • Used the Commit Assistant or mirrored its structure.

Git workflow tips (optional, but helps reviews)

  • Start by crafting the commit message locally (use the Assistant).
  • If you already committed, improve it with: 
    git commit --amend
  • Squash related commits before PR where appropriate.
  • Push your branch and then open the PR.
  • If key info is only in the PR text, maintainers may ask you to move it into the commit message for a clean history.