Skip to content

Commit 7c4c9f6

Browse files
authored
Merge pull request #165 from CBID2/patch-1
fix: make edits to Contributing guide
2 parents 39389c2 + 473405b commit 7c4c9f6

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

.github/CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Thank you for your interest in contributing a project tutorial for Codédex.
88

99
Why should you contribute to Codédex? Contributing will get you:
1010

11-
- 💪 Valuable technical writing and real-world coding experience for your personal portfolio.
11+
- 💪 Valuable technical writing and real-world coding experience that you can provide examples of for your personal portfolio.
1212
- 👩🏻‍🏫 Mentorship from the Codédex team to support your project tutorial.
13-
- 📈 Ability to publish your tutorials and grow your online presence on sites such as Dev.to, Twitter, Hacker News, and LinkedIn.
13+
- 📈 Ability to publish your tutorials and grow your online presence on sites such as [Dev.to](https://dev.to/), [X(Twitter)](https://x.com), [Hacker News](https://news.ycombinator.com/), and [LinkedIn](https://www.linkedin.com/).
1414
- 👩‍❤️‍👨 Access to Codédex premium features such as the Discord server and community events.
1515
- 👕 Free swag from the [Codédex merch shop](https://codedex.myshopify.com).
1616

@@ -20,10 +20,10 @@ Why should you contribute to Codédex? Contributing will get you:
2020
2. Once your project topic is accepted by the Codédex team, you can now start writing it!
2121
3. Make a copy of the [project template](https://github.com/codedex-io/projects/blob/main/docs/project_template.mdx), then review our [content guidelines](https://github.com/codedex-io/projects/tree/main/docs/content_guidelines.mdx), the [official MDX docs](https://mdxjs.com/docs/), and
2222
[one of our published projects](https://github.com/codedex-io/projects/blob/main/projects/generate-a-qr-code-with-python/generate-a-qr-code-with-python.mdx)
23-
to see what a final project should look like. To make sure your work renders properly, check it with an MDX previewer like [this one](https://mdxjs.com/playground/).
23+
To see what a final project should look like and ensure that it renders properly, use an MDX previewer like [this one](https://mdxjs.com/playground/).
2424
4. If you encounter any issues, feel free to reach out to [@sonnynomnom](https://www.twitter.com/sonnynomnom).
25-
5. When you finish your project tutorial, create a pull request [here](https://github.com/codedex-io/projects/pulls), referencing the issue. The Codédex team will review your PR and give you reviews and suggestions.
26-
6. Once your project tutorial is completed, your PR will be merged, and you can publish your project tutorial on the site of your choice!
25+
5. When you finish your project tutorial, [create a pull request](https://github.com/codedex-io/projects/pulls), referencing the issue. The Codédex team will then review your PR and give suggestions.
26+
6. Once your project tutorial is completed, your PR will be merged. From there, you can publish your project tutorial on the site of your choice!
2727

2828
## How do I submit a Pull Request (PR)?
2929

0 commit comments

Comments
 (0)