Hacktoberfest is here, which means open source contributions are in full swing! 🎃
However, making your very first open source contribution can be super daunting. Don’t fret, Codédex is here to help!
Here is how to contribute to open source and Hacktoberfest with Codédex and make your very first pull request to a public project on GitHub.
What is Codédex?
Codédex is an 8-bit learn to code platform by developers, for developers! One of the main features of Codédex is the project tutorials!
Codédex Projects is a catalog of fun, beginner-friendly, and real-world programming tutorials available to developers all over the world. Our goal is to create a mountain of top-notch coding content on the web, from Python to Web Development, VR/AR to Machine Learning.
Now that the MVP is out, our goal is to invite awesome content creators from the community to author one or two project tutorials, since maintaining a resource of this type at-scale is only possible if it's open-sourced. That means we need your help, whether it's contributing, reviewing (catching bugs/typos), or evangelizing!
Here are some cool examples of Codédex Projects:
- 🔗 Generate a QR Code with Python
- 📝 Generate a Blog with OpenAI
- 🎞 Create a GIF with Python
- 📊 Visualize YouTube Data with Plotly Express
- 🤖 Build a Discord Bot with Python
Why Contribute?
This is great, but why should you contribute to Codédex Projects?
- Valuable article writing and real world coding experience.
- 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, Indie Hackers, LinkedIn, and Medium.
- Access to Codédex premium features such as the Discord Server and community events.
- A free swag from our merch store.
codedex-io
/
projects
Codédex Projects 📝
🚀 Codédex Projects
The best programming tutorials on the web.Built by developers, for developers.
What are Projects?
Codédex Projects is a catalog of fun, beginner-friendly, and real-world programming tutorials available to developers all over the world. Our goal is to create a mountain of top-notch coding content on the web, from Python to Web Development, VR/AR to Machine Learning.
Here are some examples of Codédex Projects:
-
🔗 Generate a QR Code with Python -
📝 Generate a Blog with OpenAI -
🎞 Create a GIF with Python -
📊 Visualize YouTube Data with Plotly Express -
🤖 Build a Discord Bot with Python
Contributing
Ready to add your own project tutorial? Learn more by reading our Contribution Guide!
What stage of development are we in right now?
Codédex Projects is live with 6 high-quality projects. Now that the MVP is out, our goal is to invite awesome content creators from the…
Getting Started
To contribute a project tutorial for Codédex, you can follow these 3 simple steps to get started!
1. Open an Issue
First, read our contributing guidelines file to learn about the workflow for contributing.
Next, decide what topic you want to talk about! Your topic can be beginner, intermediate, or advanced (see the contributing guidelines for details)! Once you have 3-4 cool topic ideas, open an issue under codedex-io/projects, following the issue template.
Our team will get back to you with the project tutorial out of the list that you should do. Once that happens, you can start creating your project tutorial!
2. Open a Pull Request
When writing your project tutorial, feel free to reach out to @sonnynomnom with any questions. Remember that your project tutorial should be interesting and engaging for others to read, while being easy to follow! Make sure to also follow our content guidelines.
Once it is completed, simply open a pull request, following the pull request template!
How do I submit a Pull Request (PR)?
- Fork the repository.
- Clone the forked repository to your computer.
- Create and switch into a new branch.
- Create a new folder with your project tutorial .mdx file in it.
- Make a pull request to merge your fork with this repository.
3. Review and Publish
When you complete your pull request, our team will review your pull request, and provide any comments or suggestions! Once those are completed, you can publish your tutorial on any site of your choosing!
So what are you waiting for? Contribute to Codédex and make an impact in the coding and open source communities! Happy Hacktoberfest!
Jerry from Codédex 🚀
Top comments (7)
Hello! This looks great, and I would like to contribute. I'll look into it tomorrow, and see what I can do for a project. Would making a simple with pygame be a good idea? Please let me know!
Absolutely!!! 🙌
What type of game are you thinking though? Snake? Hangman?
Let us know!
I had no idea, but Snake sounds good. Not too hard to make. Do you think this would be intermediate or advanced level?
submitted an issue
Answered! Snake would be intermediate or advanced. So you don't have to explain what a
whileloop and a function is for example. You can assume that the user knows.LET'S 👏 GO 👏 BOB 👏 LIU! 👏
(also, who is bob liu?)
You can contribute any time!