SunPower / PVMismatch

An explicit Python PV system IV & PV curve trace calculator which can also calculate mismatch.

http://sunpower.github.io/PVMismatch/

BSD 3-Clause "New" or "Revised" License

79 stars 30 forks source link

add HOWTO build/deploy docs and other developer sections to docs #79

Open mikofski opened 6 years ago

mikofski commented 6 years ago

problem

there is no developer section in the docs, contributors don't know how to update, build, or deploy docs, any arbitrary conventions or traditions that have been established are undocumented.

proposal

add a Developer section to the docs that has HOWTO sections on:

building/deploying docs
conventions
CI setup
overall codebase structure/philosophy
HACKING - HOWTO setup git using feature-branch workflow
CONTRIBUTION - code of conduct, issue template

mikofski commented 6 years ago

see NREL/SAM CONTRIBUTING.md for some ideas, especially the resources for using Git/GH section