Add Documentation for Development Practices and Improve Contributing Docs

engineerjoe440 / ElectricPy

Electrical Engineering Formulas in Python

https://electricpy.readthedocs.io/en/latest/

MIT License

86 stars 16 forks source link

Add Documentation for Development Practices and Improve Contributing Docs #97

Open engineerjoe440 opened 2 years ago

engineerjoe440 commented 2 years ago

There's a real lack of documentation regarding contribution best practices and suggestions for this project. We should document some of the following:

how Pull Requests (PRs) should be managed
what documentation styles are in place (NumPyDoc)
contributions getting started
what determinations should be used to decide where new functions should be added