search

cohere-coop / nourish.party

Celebrating and nourishing creative communities
Other
6 stars 0 forks source link

RFC: What should our initial CONTRIBUTING.md include? #22

Closed zspencer closed 6 years ago

zspencer commented 6 years ago

@bhaibel has feels re: strongly encouraging i18n for all content.

I'd like it if we suggested people write feature and unit tests for their new functionality (codeclimate offers enforcement so that if the submitted diff doesn't have a high enough coverage it breaks the build)

Anything else?

zspencer commented 6 years ago

@jtu0 @emdashbuck @atav1k - thoughts from either of you?

dashbuck commented 6 years ago

Documentation! If a contributor writes code that will affect admins or hosts, they need to write documentation to cover it and update existing documentation. Documentation for admins can be in techspeak to an extent but host documentation has to be non-tech friendly.

I'd like the documentation to be OS agnostic whenever possible. It would be great if the documentation also did not assume knowledge of specific libraries or tools when possible. I don't know if either of these is enforceable however.

zspencer commented 6 years ago

@emdashbuck - We most certainly can include a pre-merge check for documentation! Inch-ci supports that across Ruby and JavaScript