Giters

chrisbouchard / easyrepr

Python decorator to automatically generate repr strings

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Make RtD docs more prominent in README and add CONTRIBUTING document

chrisbouchard opened this issue · comments

commented

This project is not currently very welcoming to new contributors — mostly because I've been the only contributor thus far and it all lives in my head. This knowledge needs to be externalized.

  1. The README should have a textual link to the Read the Docs documentation. Currently the only link in the README is a badge, which is easy to overlook.
  2. We need a CONTRIBUTING document that gives an overview of developing, testing, and building the project, as well as a brief architecture overview.