Skip to content
Jodie Putrino edited this page Apr 5, 2017 · 14 revisions

Welcome to the f5-ci-docs wiki!

Overview

This repository is the home for solution documentation relating to the F5® Container Integrations. Content on the v1 branch corresponds to content in http://clouddocs.f5.com/containers/v1/.

Development:

All development should take place in a feature branch in your fork of this repo. Rebase from upstream/master often to ensure your fork is up to date. When you're ready to submit a pull request, rebase -i and squash your commits together if you have more than a handful.

Branching:

Master is considered the version of record (aka, the 'stable' version). All content on this branch has been reviewed and is ready for public consumption.

Once contributions have been reviewed and merged into the master branch here, merge commits from master should be cherry-picked to the release branch (v1) using git cherry-pick -m 1. Project Admins can then git push upstream <release-branch> to push the merge commit to the release branch.

Review:

All work should be done in your fork. When you're ready to add your work to this repo, open a pull request. Assign at least one member of the team to review the PR by @ mentioning them in your PR comment and/or assigning the PR to that person.

  • You can combine multiple bugfixes into the same PR, as long as each fix is only one commit. Be sure to reference the bug # in the commit message.

  • If you are opening a pull request for a feature that's under development and shouldn't be merged into master yet, assign the 'New feature -- do not merge' label to your PR.

Style, Voice, Tools, etc.

NOTE: updated link to the style guide coming soon

Consult the F5 Open Source Documentation Style Guide if you have any questions about voice, style, tools, etc.

Clone this wiki locally