Open-Cap-Table-Coalition / Open-Cap-Format-OCF

Open Cap Format (OCF) - The Open Source Company Capitalization Data Standard. OCF can be used to structure and track the complex data structures necessary to build and maintain accurate capitalization (cap) tables.

Home Page:https://opencaptablecoalition.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[Enhancement]: Improve / update CONTRIBUTING, developer docs, etc.

pjohnmeyer opened this issue · comments

Description of Enhancement :

Update CONTRIBUTING.md, creating additional docs/developer docs as needed (e.g. #487) to make them well-organized. Consider updating pull request and issue templates as well to better reflect how we work today, versus how we did when they were all set up.

Instructions should at a minimum include how to set up your development environment so that folks are using the correct Node versions and pre-commit hooks are set up.

Why is this Needed?

We are starting to receive more contributions from folks who are new to the project, and having to provide instructions in a PR after the fact is inefficient and creates a bad first impression. It also can create a bad developer experience after changes are merged, if they are merged without docs being re-generated.

Anything else we need to know?