Skip to content
This repository has been archived by the owner on Jul 29, 2018. It is now read-only.

Convert CONTRIBUTING and README to AsciiDoc #234

Merged
merged 1 commit into from
May 27, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
- Fix #225: service-manager env throws NameError @budhrg
- Fix #168: Extend --debug flag to show plugin activity @budhrg
- Don't set private network for unsupported box @budhrg
- Convert CONTRIBUTING and README docs to AsciiDoc @bexelbie

## v1.0.2 May 09, 2016
- Add --script-readable to env and env docker @bexelbie
Expand Down
110 changes: 110 additions & 0 deletions CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
[[contributing-to-vagrant-service-manager]]
== Contributing to vagrant-service-manager

* link:#submitting-issues[Submitting issues]
* link:#submitting-pull-requests[Submitting pull requests]
** link:#get-started[Get Started]
** link:#create-a-topic-branch[Create a topic branch]
** link:#code[Code]
** link:#commit[Commit]
** link:#submit[Submit]
* link:#merging-pull-requests[Merging pull requests]

The following is a set of guidelines for contributing to the
vagrant-service-manager plugin.

These are guidelines, please use your best judgment and feel free to
propose changes to this document.

=== Submitting issues

You can submit issues with respect to the vagrant-service-manager plugin
https://github.com/projectatomic/vagrant-service-manager/issues/new[here].
Make sure you include all the relevant details pertaining the issue.

Before submitting a new issue, it is suggested to check the
https://github.com/projectatomic/vagrant-service-manager/issues[existing
issues] in order to avoid duplication. The vagrant-service-manager
plugin works closely with the
https://github.com/projectatomic/adb-atomic-developer-bundle/issues[Atomic
Developer Bundle] and the
https://github.com/projectatomic/adb-utils/issues[adb-utils] RPM. You
may wish to review the issues in both these repositories as well.

=== Submitting pull requests

==== Get Started

If you are just getting started with Git and GitHub there are a few
prerequisite steps.

* Make sure you have a https://github.com/signup/free[GitHub account].
* https://help.github.com/articles/fork-a-repo/[Fork] the
vagrant-service-manager repository. As discussed in the linked page,
this also includes:
** https://help.github.com/articles/set-up-git[Setting up] your local
git install.
** Cloning your fork.

==== Create a topic branch

Create a
http://git-scm.com/book/en/Git-Branching-Branching-Workflows#Topic-Branches[topic
branch] on which you will work. The convention is to name the branch
using the issue key you are working on. If there is not already an issue
covering the work you want to do, create one (see
link:#submitting-issues[submitting issues]). Assuming for example you
will be working from the master branch and working on the GitHub issue
123 : `git checkout -b issue-123 master`

==== Code

Do your work! Refer to the link:README.md#development[development]
section in the link:README.md[README] to get started.

==== Commit

* Make commits of logical units.
* Be sure to use the GitHub issue key in the commit message, eg
`Issue #123 ...`.
* Make sure you have added the necessary tests for your changes.
* Make sure you have added appropriate documentation updates.
* Run _all_ the tests to assure nothing else was accidentally broken.

==== Submit

* Push your changes to the topic branch in your fork of the repository.
* Initiate a https://help.github.com/articles/using-pull-requests/[pull
request].
* All changes need at least 2 ACKs from maintainers before they will be
merged. If the author of the PR is a maintainer, their submission is
considered to be the first ACK. Therefore, pull requests from
maintainers only need one additional ACK. By "2 ACKs" we mean that two
maintainers must acknowledge that the change is a good one.

=== Merging pull requests

A project maintainer will merge the pull request. He should avoid using
the GitHub UI for the merge and prefer merges over the the command line
to avoid merge commits and to keep a linear commit history. Here is an
example work-flow assuming issue 123 from above:

-------------------------------------------------------------------------
# Create a local branch for the pull request
$ git checkout -b issue-123 master

# Pull the changes
$ git pull <remote of the pull request> issue-123

# If necessary rebase changes on master to ensure we have a fast forward.
$ git rebase -i master

# If required, update CHANGELOG.md in the unreleased section. Commit!

# Merge changes into master
$ git checkout master
$ git merge issue-123

# Push to origin
$ git push origin master
-------------------------------------------------------------------------
107 changes: 0 additions & 107 deletions CONTRIBUTING.md

This file was deleted.

Loading