search

executablebooks / .github

Community health files: Contributing guidelines, Code of Conduct, ...
MIT License
4 stars 8 forks source link

Improve CONTRIBUTING.md #1

Closed chrisjsewell closed 4 years ago

chrisjsewell commented 4 years ago

Take more inspiration from https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors#examples-of-contribution-guidelines For example, adding a "What should I know before I get started?" section

choldgraf commented 4 years ago

Could we also add a section on release cadence and philosophy? I think that our "minimal steps to make a release" approach here opens a path towards much more frequent releases in general, that I think is worth making explicit. IMO we should try to release as often as possible, sometimes even for a single commit (as a patch release anyway). That will keep the experience that users have fresh, and will reduce the amount of burden associated with major new changes to the codebase. What do others think?

chrisjsewell commented 4 years ago

I think we have done these things now 👍