Skip to content

POC to show how we could split the contributing guide into pieces#91

Merged
seb4stien merged 7 commits intomainfrom
feat/split
Jan 15, 2026
Merged

POC to show how we could split the contributing guide into pieces#91
seb4stien merged 7 commits intomainfrom
feat/split

Conversation

@seb4stien
Copy link
Copy Markdown
Contributor

In this PR I:

  • Add a src/ folder when individual markdown files contain relevant pieces for the contributing guide.
  • Introduce a markdown template (of my own): "CONTRIBUTING.mdt" that use "!INCLUDE" directive to source other files
  • Introduce a scripts/render.py that generate the resulting CONTRIBUTING.md

The goal is to collect feedback to see if we go further with the idea to use the individual pieces of the contributing guide to generate targeted instructions for AI agents.

@seb4stien seb4stien requested a review from a team as a code owner November 24, 2025 17:14
Comment thread CONTRIBUTING.md
Comment thread scripts/render.py
Comment thread src/ci/200-failing-checks.md Outdated
Comment thread src/ci/200-failing-checks.md Outdated
Comment thread src/ci/200-failing-checks.md
Comment thread src/ci/200-failing-checks.md Outdated
Comment thread src/definitions/100-breaking-change.md
Comment thread src/definitions/300-unit-test.md Outdated
Comment thread src/definitions/400-integration-test.md
Comment thread src/definitions/500-end-to-end-test.md Outdated
Comment thread src/definitions/600-smoke-test.md Outdated
Comment thread src/definitions/600-smoke-test.md Outdated
Comment thread src/github/100-repository-setup.md Outdated
Comment thread src/github/100-repository-setup.md Outdated
Comment thread src/github/100-repository-setup.md
Comment thread src/github/200-prs.md Outdated
Comment thread src/github/200-prs.md Outdated
Comment thread src/github/200-prs.md Outdated
Comment thread src/github/200-prs.md Outdated
Comment thread src/github/200-prs.md Outdated
Copy link
Copy Markdown
Contributor

@arturo-seijas arturo-seijas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments on the guidelines themselves, although I understand that's not part of the scope of the PR

Comment thread src/tests/500-static-code-analysis.md Outdated
@seb4stien seb4stien merged commit 320c2c0 into main Jan 15, 2026
1 check passed
@seb4stien seb4stien deleted the feat/split branch January 15, 2026 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants