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

Review CONTRIBUTING file and contributing guides from the docs #1422

Open
javiertoledo opened this issue Jul 17, 2023 · 5 comments
Open

Review CONTRIBUTING file and contributing guides from the docs #1422

javiertoledo opened this issue Jul 17, 2023 · 5 comments
Assignees
Labels
contrib-experience Contributor Experience documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@javiertoledo
Copy link
Member

Documentation bug, improvement

Description

We have both a CONTRIBUTING.md file and a series of sections in our documentation dedicated to onboarding contributors. There are mismatches between these two documents. We should consider if it's time to remove the CONTRIBUTING.md file and redirect all links to the contributing guide from the docs or if it still makes sense to keep both for some reason.

In any case, let's make sure these two documents are not contradicting each other and avoid duplicating documentation that could become outdated at some point.

@javiertoledo javiertoledo added documentation Improvements or additions to documentation good first issue Good for newcomers contrib-experience Contributor Experience labels Jul 17, 2023
@Gingaaa
Copy link

Gingaaa commented Jul 31, 2023

Hey I have worked on around 7-8 company based project, but never countribute to open source, this is my first time can you assign me this task.

@Gingaaa
Copy link

Gingaaa commented Aug 1, 2023

Thanks, i will keep updating you, are you on any social platform

@Gingaaa
Copy link

Gingaaa commented Aug 9, 2023

Sir, do I need to make the both file to look similar or want to add some dissimilarity .

@javiertoledo
Copy link
Member Author

Hi @Gingaaa, sorry for the late response. I think it's better to have a single document and render it in both places. What I've done in other projects, is to load the CONTRIBUTING.md file from the docusaurus website. You can see an example in this other repository: https://github.com/theam/eLLMental-kt/blob/main/website/docs/04_community/contributing.mdx

This way, we maintain a single document but the content is properly displayed in both places.

@Gingaaa
Copy link

Gingaaa commented Sep 15, 2023

ok

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contrib-experience Contributor Experience documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants