CONTRIBUTING.rst

Contributing guidelines

Sections

• Philosophy
• Discussion
• Issue reporting
  • Scripts and documentation
  • Playbooks and roles
  • Tests
• Code submissions
  • Fork it
  • Make your contribution
  • Submit your pull request through Github
  • Update your fork
• Code style
• License agreement

Philosophy

• Do one thing well
• Modularity and flexibility
• DebOps itself is just a name, it is the sum of its parts

Discussion

Join us in #debops on Freenode or post on the debops mailing list.

Issue reporting

DebOps is officially hosted on Github at https://github.com/debops/debops.

Scripts and documentation

Checkout the debops/debops issue tracker.

Playbooks and roles

Checkout the debops/debops-playbooks issue tracker.

Tests

Checkout the debops/test-suite issue tracker.

Code submissions

We accept pull requests on everything. Here's a quick work flow:

Fork it

• Fork it into your Github account

• Clone your fork onto your workstation

  • git clone git@github.com:YOURACCOUNT/the-repo.git

• Add the official repo as your upstream

  • git remote add upstream https://github.com/debops/the-repo

Make your contribution

git checkout -b somefeaturebranch
git add <the files you modified>
git push origin somefeaturebranch

Please try your best to make great commit messages. Have a read through better commits and research how to use git add -p.

Submit your pull request through Github

Select the branch on your repo, click the green PR button and submit it.

Update your fork

You should do this before making any commits and after your PR has been accepted.

git checkout master # or whatever the main PR branch is for that repo
git fetch upstream
git rebase upstream/master
git push origin master

Code style

For everything:

• Try your best to stay under 80 characters but don't go crazy trying
• 2 space indentation for everything unless noted otherwise
• Comments and output start with a capital letter and have no periods

For just yaml:

• Prefer role_foo and role_bar to using a role dictionary
• Use the multi-line style whenever possible (we're working on migrating to that)

License agreement

By contributing you agree that these contributions are your own (or approved by your employer) and you grant a full, complete, irrevocable copyright license to all users and developers of the project, present and future, pursuant to the license of the project.