Create a CONTRIBUTING.md definition

ManderaGeneral / generalpackager

Tools to interface GitHub, PyPI, NPM and local modules / repos. Used for generating files to keep projects dry and synced. Tailored for ManderaGeneral for now.

https://pypi.org/project/generalpackager/

Apache License 2.0

0 stars 0 forks source link

Create a CONTRIBUTING.md definition #81

Open Mandera opened 1 year ago

Mandera commented 1 year ago

Welcome users
Tell them how to setup the environment
- Either clone a specific repo and then run generate.py
- Or pip install generalpackager then run Packager().create_blank_locally() or something
Mention the Apache 2 license
Small PR guide
Code style
Unittests
Principles such as DRY

Probably missed something

ZanSara commented 1 year ago

For what is worth, I could get going by just cloning the repo and running pip install -e ., which is great :slightly_smiling_face:

Out of curiosity, what would generate.py do?

Mandera commented 1 year ago

Nice, that's good to know, and definitely something that'd be nice to continue supporting! I mainly had

https://github.com/ManderaGeneral/generalpackager/issues/80

in mind. generate.py would replace pre-commit install and possibly do more, but writing this made me think