From e0e6edd2dc7a10c6bf5ed9b8e85ab62b81f4fb61 Mon Sep 17 00:00:00 2001 From: Christine Belzie <105683440+CBID2@users.noreply.github.com> Date: Tue, 22 Oct 2024 15:33:35 -0400 Subject: [PATCH 1/2] fix: make edits to Contributing guide --- .github/CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f957cac5..37f7e813 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -8,9 +8,9 @@ Thank you for your interest in contributing a project tutorial for Codédex. Why should you contribute to Codédex? Contributing will get you: -- 💪 Valuable technical writing and real-world coding experience for your personal portfolio. +- 💪 Valuable technical writing and real-world coding experience that you can provide examples of for your personal portfolio. - 👩🏻‍🏫 Mentorship from the Codédex team to support your project tutorial. -- 📈 Ability to publish your tutorials and grow your online presence on sites such as Dev.to, Twitter, Hacker News, and LinkedIn. +- 📈 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/). - 👩‍❤️‍👨 Access to Codédex premium features such as the Discord server and community events. - 👕 Free swag from the [Codédex merch shop](https://codedex.myshopify.com). @@ -20,10 +20,10 @@ Why should you contribute to Codédex? Contributing will get you: 2. Once your project topic is accepted by the Codédex team, you can now start writing it! 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 [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) -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/). +To see what a final project should looks like and ensure that it renders properly, use an MDX previewer like [this one](https://mdxjs.com/playground/). 4. If you encounter any issues, feel free to reach out to [@sonnynomnom](https://www.twitter.com/sonnynomnom). -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. -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! +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. +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! ## How do I submit a Pull Request (PR)? From 473405b9a39cb96ec407b3b517495b4f27aa3af6 Mon Sep 17 00:00:00 2001 From: Christine Belzie <105683440+CBID2@users.noreply.github.com> Date: Sat, 26 Oct 2024 17:51:29 -0400 Subject: [PATCH 2/2] fix: make looks singular again --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 37f7e813..1e60d8a5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -20,7 +20,7 @@ Why should you contribute to Codédex? Contributing will get you: 2. Once your project topic is accepted by the Codédex team, you can now start writing it! 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 [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) -To see what a final project should looks like and ensure that it renders properly, use an MDX previewer like [this one](https://mdxjs.com/playground/). +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/). 4. If you encounter any issues, feel free to reach out to [@sonnynomnom](https://www.twitter.com/sonnynomnom). 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. 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!