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

Initial 'ground rules' document #1

Closed
4 tasks
mburns opened this issue Jul 5, 2015 · 1 comment
Closed
4 tasks

Initial 'ground rules' document #1

mburns opened this issue Jul 5, 2015 · 1 comment

Comments

@mburns
Copy link
Member

mburns commented Jul 5, 2015

(since the rules repo is currently empty, it's tricky to make a PR against it. At a minimum, an empty document placeholder would be useful, so that we could iterate on it through Pull Requests)

We should have a document (presumably, README.md) that lays out the basic rules (and links to more detailed markdown documents, when needed) of how RedGuide maintains cookbooks.

This document should probably cover:

  • how to add cookbooks to the RedGuide org / request inclusion

    • maintainer or licensing (?) minimum requirements to deal with Bus Factor issues
  • preferred way to handle PRs and merging to master.

    "With great power comes great responsibility" - Uncle Ben

    • Don't push into master (unless trivial and very simple hotfix)
    • Use develop branch wherever it exists
    • Ask for 1~2 👍 before merge
    • Use the force & appeal to common sense
  • optional how to propose new rules

  • optional minimum expectations of cookbooks (CI, style, versioning, minimal supported platforms) or opinionated defaults.

@mburns
Copy link
Member Author

mburns commented Jul 5, 2015

related: redguide/redguide.github.io#2

@mburns mburns closed this as completed Oct 3, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant