nlopin
commented
2 years ago The contribution page on the website is the first point of contact and is aimed at a broader audience (devs, designers, EMs). We want to provide high-level helpful information for them and a link to the CONTRIBUTION.md for developers.
CONTRIBUTION.md should contain only technical content related to the project: workflow description, how to set up, how to develop, test, and create PR, etc.
In each document, we must explicitly state the purpose and leave a link to the other one.
Describe the feature you'd like
At the moment Wave has two different places where contribution guidelines are documented:
This can lead to potential contributors not having the full picture believing that they've already read the full contribution guidelines when in reality they've only read one of the two parts (it happened to me, I only read the CONTRIBUTING.md and after 6 months in the company I realised there was more...😅).
The idea would be to unify these two sources into one, we could only have the contribution guidelines in the documentation site and then a CONTRIBUTING.md that simply points to the site. This is the same approach that React uses, check out their CONTRIBUTING.md (it simply points to their documentation site).
I believe this would be pretty straightforward and it will make the DS easier to contribute to for new people, I can create a PR for this unification myself if enough people agree.