Add a CONTRIBUTING.md and describe the git flow workflow that is used.

ImperialCollegeLondon / pyrealm

Development of the pyrealm package, providing an integrated toolbox for modelling plant productivity, growth and demography using Python.

https://pyrealm.readthedocs.io/

MIT License

23 stars 9 forks source link

Add a CONTRIBUTING.md and describe the git flow workflow that is used. #65

Closed davidorme closed 1 year ago

MarionBWeinzierl commented 1 year ago

As a first step, we could move what is documented under Release Process in the ReadMe.

@mondus @a-smith-github , do you think it needs to be more extensive?

davidorme commented 1 year ago

I think most of the current README.md is developer-facing and should probably be in CONTRIBUTING.md. Then the README.md can just be a short overview and description of what the package does. The examples of use might go in that too, but could go to the website? We can handle this on the 71-improve-readme branch?

Incidentally - is there a particular scheme to the branch labelling that I should follow here?

davidorme commented 1 year ago

The README.md is also used as the landing page on PyPi, so needs to be user focussed and short.