Skip to content

Single source of truth for contributing documentation #260

@martimalek

Description

@martimalek

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions