You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the bug
Developer documentation:
Confusingly, there are 2 write-ups about how to contribute to the project: CONTRIBUTING.md
and docs/development.md.
There should be only 1 document that explains how to contribute to the project.
CONTRIBUTING.md is the established, typical file that explains how to contribute to a project. If all of the documentation is going to live under a documentation folder (and be generated with some process), then CONTRIBUTING.md should simply contain a note that tells potential contributors where to find the information. Ex: "Read how to contribute to this project on our documentation site in the [whatever] file. " -- and then link the text "our documentation site in the [whatever] file." should link to that file on the documentation site.
It's not clear to me if the contributing information on the documentation site is supposed to be the canonical information or not, else I'd do a PR to update CONTRIBUTING.md.
The text was updated successfully, but these errors were encountered:
weedySeaDragon
changed the title
(docs) Dev contributing duplicated in Contributing.md and
(docs) duplicated info in Contributing.md and docs/development.md
Oct 15, 2022
@weedySeaDragon, yes, we should only have one document.
Can you check #3678 and suggest the necessary changes?
I believe it would be better to have contribution guideline inside the main docs site as most people would be referring to that. A link should suffice in contributing.md.
@sidharthv96 I don't want to hold up #3678. (I'm looking forward to seeing it merged!)
I'll merge the two documents into a document that lives in the main docs site (where-ever that is after #3678 is merged) and would like to improve it some.
(Maybe that's what you meant, anyway)
And I'll just put a sentence into CONTRIBUTING.md that points people to the right place in the documentation site.
Describe the bug
Developer documentation:
Confusingly, there are 2 write-ups about how to contribute to the project:
CONTRIBUTING.md
and
docs/development.md
.There should be only 1 document that explains how to contribute to the project.
CONTRIBUTING.md
is the established, typical file that explains how to contribute to a project. If all of the documentation is going to live under a documentation folder (and be generated with some process), thenCONTRIBUTING.md
should simply contain a note that tells potential contributors where to find the information. Ex: "Read how to contribute to this project on our documentation site in the [whatever] file. " -- and then link the text "our documentation site in the [whatever] file." should link to that file on the documentation site.It's not clear to me if the contributing information on the documentation site is supposed to be the canonical information or not, else I'd do a PR to update
CONTRIBUTING.md
.The text was updated successfully, but these errors were encountered: