Skip to content

Rework README.md and extract contribution guidelines to CONTRIBUTING.md#3669

Merged
leo-scalingo merged 12 commits intomasterfrom
feat/contibuting-ref
Apr 15, 2026
Merged

Rework README.md and extract contribution guidelines to CONTRIBUTING.md#3669
leo-scalingo merged 12 commits intomasterfrom
feat/contibuting-ref

Conversation

@benjaminach
Copy link
Copy Markdown
Contributor

This pull request restructures the repository entry point to make the project easier to understand for both humans and LLMs.

The previous README.md mainly served as a contribution guide, which made it harder to immediately understand the purpose of the repository and to discover the live documentation.

At the same time, the existing contribution-focused content has been moved out of README.md and renamed to CONTRIBUTING.md, which is a more standard and discoverable location for contribution guidelines.

@benjaminach benjaminach requested review from EtienneM and Frzk April 10, 2026 07:37
@benjaminach
Copy link
Copy Markdown
Contributor Author

Since I added a link to the future llms.txt file, this must be merged after #3629 (or update this PR).

Copy link
Copy Markdown
Member

@EtienneM EtienneM left a comment

Choose a reason for hiding this comment

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

praise: thanks a lot 🤩

I'm just adding a bunch of suggestions, already approving

@leo-scalingo leo-scalingo merged commit 5062a44 into master Apr 15, 2026
3 checks passed
@leo-scalingo leo-scalingo deleted the feat/contibuting-ref branch April 15, 2026 07:54
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.

3 participants