Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 943c8df

Browse files
author
Misty Stanley-Jones
authored
Merge pull request docker#172 from mstanleyjones/add_github_templates
Add github templates
2 parents 43d996c + 62fb1de commit 943c8df

File tree

3 files changed

+174
-0
lines changed

3 files changed

+174
-0
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
## Contributing
2+
3+
We value your documentation contributions, and we want to make it as easy
4+
as possible to work in this repository. One of the first things to decide is
5+
which branch to base your work on. If you get confused, just ask and we will
6+
help. If a reviewer realizes you have based your work on the wrong branch, we'll
7+
let you know so that you can rebase it.
8+
9+
>**Note**: To contribute code to Docker projects, see the
10+
[Contribution guidelines](opensource/project/who-written-for).
11+
12+
### Quickstart
13+
14+
If you spot a problem while reading the documentation and want to try to fix it
15+
yourself, click the **Edit this page** link at the bottom of that page. The
16+
page will open in the Github editor, which means you don't need to know a lot
17+
about Git, or even about Markdown.
18+
19+
When you save, you will be prompted to create a fork if you don't already have
20+
one, and to create a branch in your fork and submit the pull request. We hope
21+
you give it a try!
22+
23+
### Overall doc improvements
24+
25+
Most commits will be made against the `master` branch. This include:
26+
27+
- Conceptual and task-based information not specific to new features
28+
- Restructuring / rewriting
29+
- Doc bug fixing
30+
- Typos and grammar errors
31+
32+
One quirk of this project is that the `master` branch is where the live docs are
33+
published from, so upcoming features can't be documented there. See
34+
[Specific new features for a project](#specific-new-features-for-a-project)
35+
for how to document upcoming features. These feature branches will be periodically
36+
merged with `master`, so don't worry about fixing typos and documentation bugs
37+
there.
38+
39+
>Do you enjoy creating graphics? Good graphics are key to great documentation,
40+
and we especially value contributions in this area.
41+
42+
### Specific new features for a project
43+
44+
Our docs cover many projects which release at different times. **If, and only if,
45+
your pull request relates to a currently unreleased feature of a project, base
46+
your work on that project's `vnext` branch.** These branches were created by
47+
cloning `master` and then importing a project's `master` branch's docs into it
48+
(at the time of the migration), in a way that preserved the commit history. When
49+
a project has a release, its `vnext` branch will be merged into `master` and your
50+
work will be visible on docs.docker.com.
51+
52+
The following `vnext` branches currently exist:
53+
54+
- **[vnext-engine](https://github.com/docker/docker.github.io/tree/vnext-engine):**
55+
docs for upcoming features in the [docker/docker](https://github.com/docker/docker/)
56+
project
57+
58+
- **[vnext-compose](https://github.com/docker/docker.github.io/tree/vnext-compose):**
59+
docs for upcoming features in the [docker/compose](https://github.com/docker/compose/)
60+
project
61+
62+
- **[vnext-distribution](https://github.com/docker/docker.github.io/tree/vnext-distribution):**
63+
docs for upcoming features in the [docker/distribution](https://github.com/docker/distribution/)
64+
project
65+
66+
- **[vnext-opensource](https://github.com/docker/docker.github.io/tree/vnext-opensource):**
67+
docs for upcoming features in the [docker/opensource](https://github.com/docker/opensource/)
68+
project
69+
70+
- **[vnext-swarm](https://github.com/docker/docker.github.io/tree/vnext-swarm):**
71+
docs for upcoming features in the [docker/swarm](https://github.com/docker/swarm/)
72+
project
73+
74+
- **[vnext-toolbox](https://github.com/docker/docker.github.io/tree/vnext-toolbox):**
75+
docs for upcoming features in the [docker/toolbox](https://github.com/docker/toolbox/)
76+
project
77+
78+
- **[vnext-kitematic](https://github.com/docker/docker.github.io/tree/vnext-kitematic):**
79+
docs for upcoming features in the [docker/kitematic](https://github.com/docker/kitematic/)
80+
project
81+
82+
## Style guide
83+
84+
If you have questions about how to write for Docker's documentation, please see
85+
the [style guide](https://docs.docker.com/opensource/doc-style/). The style guide provides
86+
guidance about grammar, syntax, formatting, styling, language, or tone. If
87+
something isn't clear in the guide, please submit an issue to let us know or
88+
submit a pull request to help us improve it.

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
### Problem description
2+
3+
<!-- Provide a brief description of the problem with
4+
the documentation.
5+
6+
If this is an issue with Docker itself, rather than
7+
the Docker documentation, this may not be the right
8+
place to file the issue. Consider filing it in the
9+
specific project's repository or asking a question
10+
on forums.docker.com.
11+
12+
You can delete these comments as you are filling out
13+
the template. -->
14+
15+
### Problem location
16+
17+
<!-- Help us find the problem quickly by choosing one of these: -->
18+
19+
[ ] I saw the problem on the following URL:
20+
21+
[ ] I couldn't find the information I wanted. I expected to find it near the
22+
following URL:
23+
24+
[ ] Other:
25+
26+
### Project version(s) affected
27+
28+
<!-- If this problem only affects specific versions of a
29+
project (like Docker Engine 1.13), mention it here. The fix
30+
may need to take that into account. -->
31+
32+
### Suggestions for a fix
33+
34+
<!--If you have specific ideas for how the problem
35+
can be addressed, let us know.-->
36+
37+
38+
39+
<!-- To improve this template, edit the .github/ISSUE_TEMPLATE.md file -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<!--Thanks for your contribution. Please use the following
2+
guidelines to help us review it. You can remove these comments
3+
as you fill out this template. -->
4+
5+
<!-- **Squash your commits**: Please use an
6+
[interactive rebase](https://help.github.com/articles/about-git-rebase/)
7+
to squash (combine) multiple commits into a single commit, to keep the
8+
commit history clean. The exception is when commits from multiple
9+
contributors exist in the same pull request. In that case, one commit
10+
per contributor is preferred, to keep the history clean but also give
11+
credit for the work to all contributors. -->
12+
13+
### Describe the proposed changes
14+
15+
<!-- Tell us what you did and why. You can leave this off if
16+
the PR title is descriptive. -->
17+
18+
### Project version
19+
20+
<!-- If this change only applies to a certain version of a project
21+
(like Docker Engine 1.13), note that here. Also, consider adding
22+
that info to the docs in your change, such as by adding
23+
"In Docker 1.13 and higher..." or similar. -->
24+
25+
<!-- Also, DO NOT base your work on master if your change is only
26+
relevant to an unreleased version of a project. Instead, base
27+
your work on the `vnext-<PROJECT>` branch, which will be merged
28+
into master when that project has a new release.-->
29+
30+
### Related issue
31+
32+
<!-- If this relates to an issue or PR in this repo, refer to it
33+
like #1234 -->
34+
35+
### Related issue or PR in another project
36+
37+
<!-- Provide one or more links to issues or pull requests in
38+
other repositories. For instance, a link to the PR that
39+
introduces a code change that this PR is documenting. -->
40+
41+
### Please take a look
42+
43+
<!-- Use this section to at-mention specific individuals who should take a
44+
look at this PR. For instance, @exampleuser123-->
45+
46+
47+
<!-- To improve this template, edit .github/PULL_REQUEST_TEMPLATE.md. -->

0 commit comments

Comments
 (0)