Skip to content

Hello there! 👋

We're really excited 😃 that you're about to contribute to the TechShikhi project! If you're unsure 😕 or afraid 😨 of anything, just know that you can't mess up here. Any contribution is valuable 💎, and we encourage you to just go ahead and try. If you don't know where to start 🤔, you can watch the videos 🎥 linked below. Feel free to ask for help; everyone is a beginner at first 😸

If you want to contribute to TechShikhi, this document 📄 is for you. It should help you to get started 🚀. If you still have questions ❓ after reading this, feel free to ask us!

Set Up the Project Locally 💻

Before you can start contributing, you'll need to set up the project locally. Here's how you can do that:

  1. Fork the repository to your own GitHub account 🍴.

  2. Clone the repository to your local machine 💾: git clone https://github.com/ai-naymul/TechShikhi.git

  3. Install mkdocs. MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation 📚. You can install it by running: pip install mkdocs

  4. Run the project locally 🏃‍♀️: mkdocs serve Now, you should be able to see the project running in your browser 🌐.

Make Changes and Contribute 🛠️

Once you have set up the project, you can make changes to it. Here's how:

  1. Create a new branch 🌿: git checkout -b <your-branch-name>

  2. Make your changes ✏️.

  3. Commit your changes 📝: git commit -m “<your-commit-message>”

  4. Push your changes to your forked repository 🚀: git push origin <your-branch-name>

  5. Create a Pull Request from your forked repository to our main repository 📮.

Conclusion 🎈

And that's it! You've just contributed to the TechShikhi project! 🎉

We're really glad 😊 for your contribution, and we hope this document makes the process easier. If you have any questions or suggestions, feel free to open an issue or submit a pull request.

Happy coding! 💻