Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

51 lines (37 loc) · 3.33 KB
Raw

Codédex Projects: Contribution Guide 👩🏻‍💻👨🏾‍💻👩🏼‍💻

Welcome to the Codédex Projects GitHub repo!

Thank you for your interest in contributing a project tutorial for Codédex. 🫶

Why Contribute?

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

  • 💪 Valuable technical writing and real-world coding experience 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.
  • 👩‍❤️‍👨 Access to Codédex premium features such as the Discord server and community events.
  • 👕 Free swag from the Codédex merch shop.

How to Contribute

  1. Open an issue here with the title “Project Tutorial - Name” and follow the auto-generated issue content. The team will get back to you about your issue, either to approve your topic or to suggest a different one.
  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, then review our content guidelines, the official MDX docs, and one of our published projects 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.
  4. If you encounter any issues, feel free to reach out to @sonnynomnom.
  5. When you finish your project tutorial, create a pull request here, 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!

How do I submit a Pull Request (PR)?

  1. Fork this repository.
  2. Clone the forked repository to your computer.
git clone https://github.com/[your-GitHub-username]/projects.git
  1. Change into the projects directory with cd projects.
  2. Create and switch into a new branch with git checkout -b new-branch-name.
  3. Create a new folder with your project tutorial .mdx file in it (the names should match).
  4. Add your project content to the folder you made, including text (.mdx), media (.jpg, .png, etc.), and code examples (.html, .css, .py, etc.).
  5. Set your file(s) up for a commit with git add followed by the file(s).
  6. Commit and push your changes to your remote repo with the following:
git commit -m "a descriptive commit message"
git push -u origin new-branch-name
  1. After pushing the changes, go back to your fork on GitHub and there should be a prompt to create a new pull request.

Prompt For a New Pull Request