Skip to content

Commit d750137

Browse files
committed
* fix formatting for editors
* fix formatting for numbered lists again * add self as contributor
1 parent 753234c commit d750137

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

docs/guides/contribute/beginners.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: First Time Contributors Guide
33
author: Krista Burdine
4-
contributors: Ezequiel Bruni
4+
contributors: Ezequiel Bruni, Steven Spencer
55
tags:
66
- contributing
77
- documentation
@@ -31,12 +31,12 @@ Markdown is an easy language that allows you to include formatting, code, and pl
3131

3232
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.
3333

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.
4040

4141
## Create a local repository
4242

@@ -56,44 +56,44 @@ _Add a missing word, correct an error, clarify a confusing bit of text._
5656

5757
1. Start on the page you want to update.
5858

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.
6060

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.
6262

6363
2. Make your changes
6464

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.
6666

6767
3. Propose changes
6868

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.
7070

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."
7272

73-
**Note: Word your action in the present tense.**
73+
**Note: Word your action in the present tense.**
7474

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.
7676

7777
4. Review changes
7878

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.
8080

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.
8282

8383
5. Create Pull Request
8484

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.
8686

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.
8888

8989
6. Wait
9090

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.
9292

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
9696

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.
9898

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

Comments
 (0)