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

Docs: Add contribution file to the project #38

Merged
merged 9 commits into from
Jan 28, 2025
Merged

Conversation

Sarrabah
Copy link
Collaborator

@Sarrabah Sarrabah commented Jan 20, 2025

Goal

As outlined in issue #32, the aim of this PR is to create a CONTRIBUTING.md file that provides detailed guidance for developers on how to contribute effectively to the project.

Fix #32

@Sarrabah Sarrabah changed the title Docs: Add a contribution file to the project Docs: Add contribution file to the project Jan 20, 2025
@johanricher
Copy link
Member

Looks good to me, great work! I would only suggest adding at the bottom of the format list a link titled "How to add a new format?" pointing to the related doc, since CONTRIBUTING.md is usually more for general guidelines rather than a specific or technical how-to, some people may not look for it there.

@Sarrabah
Copy link
Collaborator Author

Thank you @johanricher for your feedback! I just have one question please, when you said "pointing to the related doc," did you mean that you would prefer I add a link pointing to the section Implementing a new French format in the CONTRIBUTING.md file?

@johanricher
Copy link
Member

I meant adding a link, at the bottom of the format list, to the CONTRIBUTING.md file (specifically the part explaining how to add a new format)

@Sarrabah Sarrabah merged commit 8002c30 into main Jan 28, 2025
1 check passed
@Sarrabah Sarrabah deleted the docs/contribution branch January 28, 2025 10:06
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.

Documenter comment ajouter un nouveau format
3 participants