boostercloud / booster

Booster Framework
https://www.boosterframework.com
Apache License 2.0
416 stars 86 forks source link

Review CONTRIBUTING file and contributing guides from the docs #1422

Open javiertoledo opened 1 year ago

javiertoledo commented 1 year ago

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.

Gingaaa commented 1 year ago

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 commented 1 year ago

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

Gingaaa commented 1 year ago

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

javiertoledo commented 1 year ago

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 commented 1 year ago

ok