Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ensure all plugins have a CONTRIBUTING.md file #61

Open
1 of 2 tasks
mbbroberg opened this issue Oct 6, 2017 · 3 comments
Open
1 of 2 tasks

Ensure all plugins have a CONTRIBUTING.md file #61

mbbroberg opened this issue Oct 6, 2017 · 3 comments

Comments

@mbbroberg
Copy link
Contributor

mbbroberg commented Oct 6, 2017

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:

  • Create a decent, default CONTRIBUTING file for a plugin
  • Link it here

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

@mbbroberg
Copy link
Contributor Author

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
Copy link
Contributor Author

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

@mbbroberg
Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants