Skip to content

fix: make edits to Contributing guide #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 26, 2024
Merged

fix: make edits to Contributing guide #165

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0e6edd
fix: make edits to Contributing guide
CBID2 Oct 22, 2024
473405b
fix: make looks singular again
CBID2 Oct 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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 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 [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)?

Expand Down