Contributing

Common Voice
5

Hi @mhenretty,

thanks for getting back to me :slight_smile:

I was thinking something along what other OSS projects use, and what GitHub recommends to be in a CONTRIBUTING file.

Some of the points I think would be great to mention there:

  • points and methods of communicating with the team/maintainers
    • e.g. GH issues for bug reports/feature requests, Discourse for more general discussion, whatever real-time chat avenue comes out of our other conversation
  • more details on setting up the local development environment
    • list of software required (e.g. MySQL isnā€™t currently mentioned anywhere)
    • versions required (esp. Node and npm, see #423)
    • where configuration goes, and what needs to be configured to get up and running; possibly also where to get backend/DB and AWS credentials (see also: #427)
    • some of these technical details could also be extracted to another file (main README or a readme in another folder, or another file entirely), and referenced from CONTRIBUTING
  • where to start in terms of things to change/fix/add
    • filter for ā€œhelp wantedā€ issues on GH
    • ignore the ā€œtriageā€ tag (or not? otherwise indicate how you use and interpret the triage tag, and how this affects "ready for development)

While I started issue #423 with a more narrow request, it could be broadened to starting contribution guidelines.

Otherwise, Iā€™m also happy to open another ticket ā€“ just thought I didnā€™t want to flood your inbox over the weekend :wink: