search

sensu-plugins / community

Your place to contribute to Sensu plugins and their maintainers
http://sensu-plugins.io
MIT License
20 stars 9 forks source link

Ensure all plugins have a CONTRIBUTING.md file #61

Open mbbroberg opened 7 years ago

mbbroberg commented 7 years ago

From previous work:

A user want to start contributing to sensu, what do they do? Below is a rough start on documenting all that is needed.

Getting Started

Developer Guidelines

Testing Process

I'd like to take this work, merge into something we want to use and then use a tool to open PRs across all our plugins (I have one I like for that). So this issue would be to:

And that's it - from there I'll take it and distribute to all other plugins. Start wherever you'd like 😄

mbbroberg commented 7 years ago

Contributing can emulate some of the workflow layout work that Kubernetes has perfectly done here: https://github.com/kubernetes/community/blob/master/contributors/devel/development.md

Having that in each contrib file will keep people informed on how to manage their forks and thus reduce the chance of rebasing issues.

mbbroberg commented 7 years ago

Another example of this done well: https://github.com/jekyll/jekyll/blob/master/docs/_docs/contributing.md

mbbroberg commented 7 years ago

Merged. Will close this issue after distributing it: https://github.com/sensu-plugins/community/blob/master/templates/CONTRIBUTING.md