Vocabulary: Add Contributing and Usage guide to the README
The guides for contribution and usage should also be there on the README.md of the project. I think it's better to add the content there then just links.
rajat2502
All 12 comments
@rajat2502 the main problem with that is that we will need to sync changes in two places. It's better to have a single source for all documentation, and that includes guides.
dhruvkb
on 13 May 2020
I'm closing the issue till you can...
dhruvkb
on 13 May 2020
@rajat2502 the main problem with that is that we will need to sync changes in two places. It's better to have a single source for all documentation, and that includes guides.
Yeah, I agree on that but we could remove the docs from the website/storybook and keep them here in the README section, or maybe just add the contributing guides to the repository because that's the first thing anyone would think of after viewing the repository.
rajat2502
on 13 May 2020
@rajat2502 I agree to your point
fakela
on 13 May 2020
@rajat2502 they're pretty long and detailed. Even @fakela in their PR pasted a small portion and lined to the Storybook for the full docs. But there's no harm in having a discussion on it. It's Season of Docs after all, so all docs are up for change.
dhruvkb
on 13 May 2020
Okay, agreed! I feel there is not much need for the contributing guidelines on the storybook. I mean that's something meant for the repository. If not in the readme maybe we can add them to the contributing.md file.
rajat2502
on 13 May 2020
@dhruvkb @rajat2502 we can always have a discussion on a better approach for this.
fakela
on 13 May 2020
@dhruvkb So, should I make another issue for moving the contributing guidelines to the markdown files?
rajat2502
on 13 May 2020
Still deliberating on it. I'm still on the fence about putting in that effort. @rajat2502 are the instructions hard to find in the Storybook?
dhruvkb
on 14 May 2020
Not exactly but it's always easier when approaching the project few
important details are present in the readme then for more detailed
explanation the user can move to the story book
fakela
on 14 May 2020
Still deliberating on it. I'm still on the fence about putting in that effort. @rajat2502 are the instructions hard to find in the Storybook?
It's not hard to find them, but in a normal production app that is open source they just provide you the link to the repository and all the guidelines related to contributions, best practices are listed there on the repository.
rajat2502
on 14 May 2020
I'll tag some other developers for their inputs as well. @hugosolar and @brenoferreira would you have some comments?
dhruvkb
on 15 May 2020
Related issues
zackkrida
路
5Comments
nimishbongale
路
4Comments
zackkrida
路
3Comments
panchovm
路
3Comments
obulat
路
5Comments
Most helpful comment
Okay, agreed! I feel there is not much need for the contributing guidelines on the storybook. I mean that's something meant for the repository. If not in the readme maybe we can add them to the contributing.md file.