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.
This commit addresses several documentation inconsistencies and updates:
- Corrected `README.md` and `CONTRIBUTING.md` to accurately state that
documentation is located in the `doc/` directory of this repository,
not in a separate `rsyslog-doc` project.
- Added a placeholder file for the `omczmq` module documentation at
`doc/source/configuration/modules/omczmq.rst`, as it was previously missing.
- Updated `doc/README.md` to recommend Python 3 and a modern Sphinx version
for building documentation, removing outdated Python 2.7 references.
- Updated `doc/source/conf.py` to set `needs_sphinx = '4.5.0'` (from '1.5.1').
- Clarified the "WildCards" section in
`doc/source/configuration/modules/imfile.rst` to better reflect current
functionality regarding wildcard usage in paths and filenames.
These changes aim to improve the accuracy and maintainability of the
project's documentation.
The README now links to https for the mailing list, summarizes development
container usage, and clarifies how to run tests. CONTRIBUTING references
AGENTS.md and switches AI commit guidance to use a footer. AGENTS.md now
explicitly discourages prefixing commit messages.
AI-Agent: Codex 2025-06
This commit updates all contributor-facing documentation:
- **README.md**: Modernized structure and clarified installation/build sections. Removed obsolete local doc references and replaced with link to rsyslog-doc project.
- **CONTRIBUTING.md**: Refactored for clarity, added guidance for AI-generated code (e.g. commit prefix `AI:`), formalized use of draft PRs for experiments, and removed outdated advice on "testing new releases." Added rationale for continued use of `master` branch due to ecosystem dependencies.
- **AGENTS.md** (new): Introduces clear guidelines for AI-based agents contributing to rsyslog. Includes commit formatting, PR branch expectations, testing environment, and behavioral rules.
**Why now?**
Over the past two years, we've continuously evaluated the evolving capabilities of AI development agents. We now consider them mature enough to be integrated into the rsyslog development workflow—under careful human review. This documentation update provides the foundation to onboard such agents in a controlled, auditable, and high-quality manner.
All changes prioritize traceability and developer clarity—both human and AI.
closes: https://github.com/rsyslog/rsyslog/issues/5657
The check of HAVE_LIBLOGGING_STDLOG set via AC_DEFINE fails due to it staying undefined in the configure execution context,
fixes#3431 - auxiliary var added to split logic from testbench check and correctly pass test if library is present
AC_DEFINE untouched due to need for testbench ifdefs.
[CodeTriage](https://www.codetriage.com/) is an app I have maintained
for the past 4-5 years with the goal of getting people involved in
Open Source projects like this one. The app sends subscribers a random
open issue for them to help "triage". For some languages you can also
suggested areas to add documentation.
The initial approach was inspired by seeing the work of the small
core team spending countless hours asking "what version was
this in" and "can you give us an example app". The idea is to
outsource these small interactions to a huge team of volunteers
and let the core team focus on their work.
I want to add a badge to the README of this project. The idea is to
provide an easy link for people to get started contributing to this
project. A badge indicates the number of people currently subscribed
to help the repo. The color is based off of open issues in the project.
Here are some examples of other projects that have a badge in their
README:
- https://github.com/crystal-lang/crystal
- https://github.com/rails/rails
- https://github.com/codetriage/codetriage
Thanks for building open source software, I would love to help you find some helpers.
