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

added example issue number to kitematic contributors guide instead of… #50

Merged
merged 1 commit into from
Dec 29, 2015
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
10 changes: 4 additions & 6 deletions docs/kitematic/create_pr.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,15 @@ Rebasing helps verify that your commit is clean, and allows for an easier and fa

Once you've cleaned up your commits:

1. Push your code to your repository under the same name as your local branch.
1. Push your code to your repository under the same name as your local branch (in the case of this example, 1191-branch).

$ git push origin xxxx-branch:xxxx-branch

where _xxxx_ is the number of the issue your worked on.
$ git push origin 1191-branch:1191-branch

2. Open a web browser to your fork on GitHub.

You should see the latest activity from your branch.

3. Click "Compare & pull request."
3. Click **Compare & pull request**.

The system displays the pull request dialog.

Expand All @@ -48,7 +46,7 @@ Once you've cleaned up your commits:

![Commits](images/pr_commits_expected.png)

6. Press "Create pull request".
6. Click **Create pull request**.

The system creates the request and opens it for you in the `kitematic/kitematic`
repository.
Expand Down
6 changes: 3 additions & 3 deletions docs/kitematic/find_issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Currently, the Kitematic GUI shows the name of a selected container, but not the

To find and claim an issue you want to work on:

1. Go to the `kitematic/kitematic` <a href="https://github.com/kitematic/kitematic" target="_blank">repository</a>.
1. Go to the `docker/kitematic` <a href="https://github.com/docker/kitematic" target="_blank">repository</a>.

2. Click the "Issues" link.
2. Click the **Issues** link.

A list of the open issues appears.

Expand All @@ -31,7 +31,7 @@ To find and claim an issue you want to work on:

The comments on the issues describe the problem and can provide information for a potential solution.

For this exercise we will select the issue #xxxx Missing container id.
For this exercise we will select the issue <a href="https://github.com/docker/kitematic/issues/1191" target="_blank">#1191 Missing container id</a>.

5. When you find an open issue that both interests you and is unclaimed, add a
`#dibs` comment. Make sure that no other user has chosen to work on the issue.
Expand Down
2 changes: 1 addition & 1 deletion docs/kitematic/next_steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ As you learned in the previous exercise, adding the container id to the containe

Let's provide another missing piece of information for Kitematic users:

_When I look at an active container in Kitematic, I want to know what command the container is currently running_
"_When I look at an active container in Kitematic, I want to know what command the container is currently running_."

![An active container in Kitematic](images/kitematic_gui_container_id.png)

Expand Down
12 changes: 6 additions & 6 deletions docs/kitematic/set_up_dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,12 @@ the above installer link will have an uninstaller available.

To fork the master branch of Kitematic:

1. Go to the <a href="https://github.com/docker/kitematic "target="_blank">kitematic/kitematic repository </a>.
1. Go to the <a href="https://github.com/docker/kitematic "target="_blank">docker/kitematic repository </a>.

2. Click "Fork" in the upper right corner of the GitHub interface.
2. Click **Fork** in the upper right corner of the GitHub interface.

GitHub forks the repository to your GitHub account. The original
`kitematic/kitematic` repository becomes a new fork `YOUR_ACCOUNT/kitematic`
`docker/kitematic` repository becomes a new fork `YOUR_ACCOUNT/kitematic`
under your account.

3. Copy your fork's clone URL from GitHub.
Expand All @@ -95,9 +95,9 @@ To clone your repository and create a branch for the issue:

4. Create and checkout a branch for the issue you will be working on.

$ git checkout -b xxxx-branch
$ git checkout -b 1191-branch

where _xxxx_ is the number of the issue previously noted.
As previously mentioned, issue <a href="https://github.com/docker/kitematic/issues/1191" target="_blank">#1191</a> is set up as an example to use for this exercise.

## Set up your signature and upstream remote
You can set your signature globally or locally.
Expand All @@ -117,7 +117,7 @@ You can set your signature globally or locally.
4. Set your local repository to track changes upstream, on the `kitematic`
repository.

$ git remote add upstream https://github.com/kitematic/kitematic.git
$ git remote add upstream https://github.com/docker/kitematic.git

(To learn more, see <a
href="http://docs.docker.com/opensource/project/set-up-git/#set-your-signature-and-an-upstream-remote" target="_blank"> Set up your signature and an upstream remote</a>.)
Expand Down
2 changes: 1 addition & 1 deletion docs/kitematic/work_issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ weight=4

## Develop in Kitematic (work on an issue)

For this tutorial, we will work on issue #XXXX which is a request to display the container id in Kitematic for easy identification. (Currently, Kitematic shows the container name but not the id.)
For this tutorial, we will work on issue <a href="https://github.com/docker/kitematic/issues/1191" target="_blank"> #1191</a> which is a request to display the container id in Kitematic for easy identification. (Currently, Kitematic shows the container name but not the id.)

To do this, edit the container `General Settings` layout.

Expand Down