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
Copy file name to clipboardExpand all lines: docs/guides/contribute/beginners.md
+24-24Lines changed: 24 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: First Time Contributors Guide
3
3
author: Krista Burdine
4
-
contributors: Ezequiel Bruni
4
+
contributors: Ezequiel Bruni, Steven Spencer
5
5
tags:
6
6
- contributing
7
7
- documentation
@@ -31,12 +31,12 @@ Markdown is an easy language that allows you to include formatting, code, and pl
31
31
32
32
To create a local repository, first find and install a Markdown editor that works with your computer and operating system. Here are some options, but there are others. Use what you know.
33
33
34
-
[ReText](https://github.com/retext-project/retext) - Free, cross-platform, and open source
35
-
[Zettlr](https://www.zettlr.com/) - Free, cross-platform, and open source
36
-
[Mark Text](https://github.com/marktext/marktext) - Free, cross-platform, and open source
37
-
[Remarkable](https://remarkableapp.github.io/) - Linux and Windows, open source
38
-
[NvChad](https://nvchad.com/) for the vi/vim user and the nvim client. A lot of plugins are available to enhance the editor for markdown. See [this document](https://docs.rockylinux.org/books/nvchad/) for a nice set of installation instructions.
39
-
[VS Code](https://code.visualstudio.com/) - Partially open source, by Microsoft. VS Code is a lightweight and powerful editor available for Windows, Linux and MacOS. To contribute to this document project, you should get the following extensions: Git Graph, HTML Preview, HTML Snippets, Markdown All in One, Markdown Preview Enhanced, Markdown Preview Mermaid Support, and any more that catch your fancy.
34
+
*[ReText](https://github.com/retext-project/retext) - Free, cross-platform, and open source
35
+
*[Zettlr](https://www.zettlr.com/) - Free, cross-platform, and open source
36
+
*[Mark Text](https://github.com/marktext/marktext) - Free, cross-platform, and open source
37
+
*[Remarkable](https://remarkableapp.github.io/) - Linux and Windows, open source
38
+
*[NvChad](https://nvchad.com/) for the vi/vim user and the nvim client. A lot of plugins are available to enhance the editor for markdown. See [this document](https://docs.rockylinux.org/books/nvchad/) for a nice set of installation instructions.
39
+
*[VS Code](https://code.visualstudio.com/) - Partially open source, by Microsoft. VS Code is a lightweight and powerful editor available for Windows, Linux and MacOS. To contribute to this document project, you should get the following extensions: Git Graph, HTML Preview, HTML Snippets, Markdown All in One, Markdown Preview Enhanced, Markdown Preview Mermaid Support, and any more that catch your fancy.
40
40
41
41
## Create a local repository
42
42
@@ -56,44 +56,44 @@ _Add a missing word, correct an error, clarify a confusing bit of text._
56
56
57
57
1. Start on the page you want to update.
58
58
59
-
Click the “Edit” pencil in the upper right corner of the document you want to update. You will be taken to the original document on GitHub.
59
+
Click the “Edit” pencil in the upper right corner of the document you want to update. You will be taken to the original document on GitHub.
60
60
61
-
The first time you contribute to the RL repository, you will be prompted with a green button to “**Fork** this **repository** and propose changes.” This creates a duplicate copy of the RL repository where you make your suggested edits. Simply click the green button and continue.
61
+
The first time you contribute to the RL repository, you will be prompted with a green button to “**Fork** this **repository** and propose changes.” This creates a duplicate copy of the RL repository where you make your suggested edits. Simply click the green button and continue.
62
62
63
63
2. Make your changes
64
64
65
-
Follow the Markdown formatting. Perhaps there’s a missing word, or the link on line 21 needs to be fixed, for example. Make the necessary change.
65
+
Follow the Markdown formatting. Perhaps there’s a missing word, or the link on line 21 needs to be fixed, for example. Make the necessary change.
66
66
67
67
3. Propose changes
68
68
69
-
At the bottom of the page, write a one-line description in the title of the block entitled, “**Propose changes”**. It is helpful, but not necessary, to reference the file name found at the top of the doc.
69
+
At the bottom of the page, write a one-line description in the title of the block entitled, “**Propose changes”**. It is helpful, but not necessary, to reference the file name found at the top of the doc.
70
70
71
-
So, if you updated a link within line 21 of the markdown text, you’d say something like, "Update README.md with correct links."
71
+
So, if you updated a link within line 21 of the markdown text, you’d say something like, "Update README.md with correct links."
72
72
73
-
**Note: Word your action in the present tense.**
73
+
**Note: Word your action in the present tense.**
74
74
75
-
Then click Propose changes, which will **Commit** your changes to a complete document within your forked repository.
75
+
Then click Propose changes, which will **Commit** your changes to a complete document within your forked repository.
76
76
77
77
4. Review changes
78
78
79
-
Now you can look at what you’ve done, line by line. Did you miss anything? Back up to the previous page and correct it again (you’ll have to start over), then click Propose Changes again.
79
+
Now you can look at what you’ve done, line by line. Did you miss anything? Back up to the previous page and correct it again (you’ll have to start over), then click Propose Changes again.
80
80
81
-
Once the doc is the way you want it, click the green button that says Create Pull Request. This provides one more chance to double check your changes and confirm the doc is ready.
81
+
Once the doc is the way you want it, click the green button that says Create Pull Request. This provides one more chance to double check your changes and confirm the doc is ready.
82
82
83
83
5. Create Pull Request
84
84
85
-
All of your work so far has been done in your own repository, with no opportunity to break the RL main repository. Next you submit it to the documentation team to merge your version into the main version of the document.
85
+
All of your work so far has been done in your own repository, with no opportunity to break the RL main repository. Next you submit it to the documentation team to merge your version into the main version of the document.
86
86
87
-
Click the big green button that says Create Pull Request. Good news, you still haven’t broken anything, because now it goes to the RL documentation team for review.
87
+
Click the big green button that says Create Pull Request. Good news, you still haven’t broken anything, because now it goes to the RL documentation team for review.
88
88
89
89
6. Wait
90
90
91
-
Once the RL team gets your request, they will respond in one of three ways.
91
+
Once the RL team gets your request, they will respond in one of three ways.
92
92
93
-
* Accept and merge your PR
94
-
* Comment with feedback and ask for changes
95
-
* Deny your PR with explanation
93
+
* Accept and merge your PR
94
+
* Comment with feedback and ask for changes
95
+
* Deny your PR with explanation
96
96
97
-
The last response is unlikely. We really want to include your perspective here! If you have to make changes, you’ll suddenly understand why you need a local repository. The team can [talk you through](https://chat.rockylinux.org/rocky-linux/channels/documentation) what to do next. In good news, it’s still fixable. Follow the comment section of that request to see what further information is requested.
97
+
The last response is unlikely. We really want to include your perspective here! If you have to make changes, you’ll suddenly understand why you need a local repository. The team can [talk you through](https://chat.rockylinux.org/rocky-linux/channels/documentation) what to do next. In good news, it’s still fixable. Follow the comment section of that request to see what further information is requested.
98
98
99
-
Otherwise, your request will be accepted and merged. Welcome to the team, you’re officially a contributor now! Look for your name to show up on the all-contributors list at the bottom of the Contributor Guide in a few days.
99
+
Otherwise, your request will be accepted and merged. Welcome to the team, you’re officially a contributor now! Look for your name to show up on the all-contributors list at the bottom of the Contributor Guide in a few days.
0 commit comments