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) duplicated info in Contributing.md and docs/development.md #3682

Closed
weedySeaDragon opened this issue Oct 15, 2022 · 3 comments · Fixed by #3814
Closed

(docs) duplicated info in Contributing.md and docs/development.md #3682

weedySeaDragon opened this issue Oct 15, 2022 · 3 comments · Fixed by #3814
Assignees

Comments

@weedySeaDragon
Copy link
Contributor

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.

@weedySeaDragon weedySeaDragon added Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect labels Oct 15, 2022
@weedySeaDragon 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
@sidharthv96
Copy link
Member

@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 sidharthv96 added Area: Documentation and removed Type: Bug / Error Something isn't working or is incorrect Status: Triage Needs to be verified, categorized, etc labels Oct 17, 2022
@weedySeaDragon
Copy link
Contributor Author

@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.

@jgreywolf
Copy link
Contributor

@weedySeaDragon Status?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants