You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 12, 2021. It is now read-only.
CoreOS documentation is released under the [Apache 2.0 License][asl], and we welcome contributions. Check out the [help-wanted tag][help-wanted] in this project's Issues list for good places to start participating.
4
+
5
+
Submit fixes and additions in the form of [GitHub *Pull Requests* (PRs)][pull-requests]. The general process is the typical git fork-branch-PR-review-merge cycle:
6
+
7
+
1. Fork this repository into your GitHub account
8
+
2. Make changes in a topic branch or your fork's `master`
9
+
3. Send a Pull Request from that topic branch to coreos/docs
10
+
4. Maintainers will review the PR and either merge it or make comments
11
+
12
+
Cognizance of the tribal customs described and linked to below will help get your contributions incorporated with the greatest of ease.
13
+
14
+
## Clear commit messages
15
+
16
+
Commit messages follow a format that makes clear **what** changed and **why** it changed. The first line of each commit message should clearly state what module or file changed, summarize the change very briefly, and should end, without a period, somewhere short of 70 characters. After a blank line, the body of the commit message should then explain why the change was needed, with lines wrapped at 72 characters wide and sentences normally punctuated. Cite related issues or previous revisions as appropriate. For example:
17
+
18
+
```
19
+
ignition: Update etcd example to use %m
20
+
21
+
Make the etcd configuration example use ignition's %m instead of the
22
+
ETCD_NAME environment variable. Fixes #123.
23
+
```
24
+
25
+
This format can be described somewhat more formally as:
26
+
27
+
```
28
+
<module or file name>: <what changed>
29
+
<BLANK LINE>
30
+
<why this change was made>
31
+
<BLANK LINE>
32
+
[<footer>]
33
+
```
34
+
35
+
Where the optional `[<footer>]` might include `signed-off-by` lines and other metadata.
36
+
37
+
## Style guide
38
+
39
+
The [style guide][style] prescribes the conventions of formatting and English style preferred in CoreOS project documentation.
40
+
41
+
## Translations
42
+
43
+
We happily accept accurate translations. Please send the documents as a pull request and follow two guidelines:
44
+
45
+
1. Name the files identically to the originals, but put them beneath a directory named for the translation's `gettext` locale. For example: `JA_JP/doc.md`, `ZH_CN/doc.md,` or `KO_KN/doc.md`.
46
+
47
+
2. Add an explanation about the translated document to the top of the file: "These documents were translated into Esperanto by Community Member <[email protected]> and last updated on 2015-12-01. If you find inaccuracies or problems please file an issue on GitHub."
Copy file name to clipboardexpand all lines: README.md
+2-44
Original file line number
Diff line number
Diff line change
@@ -4,53 +4,11 @@ This repository contains the Markdown source of the [CoreOS documentation][coreo
4
4
5
5
## Contributing
6
6
7
-
The CoreOS documentation is released under the [Apache 2.0 License][asl], and we welcome contributions. Check out the [help-wanted tag][help-wanted] in this project's Issues list for good places to start participating.
8
-
9
-
Submit fixes and additions in the form of [GitHub *Pull Requests* (PRs)][pull-requests]. The general process is the typical git fork-branch-PR-review-merge cycle:
10
-
11
-
1. Fork this repository into your git workspace and/or GitHub account
12
-
2. Make changes in a topic branch or your fork's `master`
13
-
3. Send a Pull Request from the branch containing the changes
14
-
4. Maintainers will review the PR and either merge it or make comments
15
-
16
-
### Clear commit messages
17
-
18
-
Commit messages should loosely follow a format that makes clear **what** changed and **why** it changed. The first line of each commit message should clearly state what module or file changed, summarize the change very briefly, and should end, without a period, somewhere short of 70 characters. After a blank line, the body of the commit message should then explain why the change was needed, with lines wrapped at 72 characters wide and sentences normally punctuated. Cite related issues or previous revisions as appropriate. For example:
19
-
20
-
```
21
-
ignition: Update etcd example to use %m
22
-
23
-
Make the etcd configuration example use ignition's %m instead of the
24
-
ETCD_NAME environment variable. Fixes #123.
25
-
```
26
-
27
-
This format can be described somewhat more formally as:
28
-
29
-
```
30
-
<module or file name>: <what changed>
31
-
<BLANK LINE>
32
-
<why this change was made>
33
-
<BLANK LINE>
34
-
[<footer>]
35
-
```
36
-
37
-
Where the optional `[<footer>]` might include `signed-off-by` lines and other metadata.
38
-
39
-
### Style guide
40
-
41
-
The [style guide][style] prescribes the conventions of formatting and English style preferred in CoreOS project documentation.
42
-
43
-
### Translations
44
-
45
-
We happily accept accurate translations. Please send the documents as a pull request and follow two guidelines:
46
-
47
-
1. Name the files identically to the originals, but put them beneath a directory named for the translation's `gettext` locale. For example: `JA_JP/doc.md`, `ZH_CN/doc.md,` or `KO_KN/doc.md`.
48
-
49
-
2. Add an explanation about the translated document to the top of the file: "These documents were translated into Esperanto by Community Member <[email protected]> and last updated on 2015-12-01. If you find inaccuracies or problems please file an issue on GitHub."
7
+
CoreOS documentation is released under the [Apache 2.0 License][asl], and we welcome contributions. Check out the [help-wanted tag][help-wanted] in this project's Issues list for good places to start participating, and review the [contribution guidelines][contributing] to find out how to submit your edits and improvements.
0 commit comments