Welcome to the OWASP NIE Student Chapter's Open Source Hacktoberfest repository! We are excited to have you as part of our community, where you can contribute to open-source projects and enhance your coding skills. This repository is designed to encourage students to collaborate and share their code with the world while participating in Hacktoberfest.
Hacktoberfest is a month-long celebration of open-source software. It encourages contributions to open-source projects and provides an opportunity for developers to engage with the global open-source community.
Contributing to this repository is easy! Follow these steps to get started:
-
Fork this repository: Click the "Fork" button in the top right corner of this page to create a copy of this repository in your own GitHub account.
-
Clone your fork: Use
git clone
to create a local copy of your fork on your computer.git clone https://github.com/your-username/open-source-hacktoberfest.git
-
Create a new branch: Create a new branch for your contributions. The branch name should be your own name in full, following kebab-casing. For example, Arnav Bhattacharya would make a branch named arnav-bhattacharya
git checkout -b your-branch-name
-
Contribute Code: Add your code to the appropriate category-specific folder within the repository. Ensure that your code adheres to the project's rules and regulations (see below).
-
Commit your changes: Commit your code changes with a clear and concise message.
git commit -m "Added feature/fix for XYZ"
-
Push your changes: Push your changes to your fork on GitHub.
git push origin your-branch-name
-
Open a Pull Request: Go to the original repository and click on "New Pull Request." Follow the instructions to submit your contribution.
-
Add your details to contributors.json: Add your details in the specified format to contributors.json once one of your PRs get merged. At the end of Hacktoberfest, we will update the readme.md with your photo, name and github ID, so that you can flex that you participated in Hacktoberfest 2023.
To maintain a positive and collaborative environment, please adhere to the following rules and regulations when contributing to this repository:
-
Go through the Hacktoberfest website for any doubts Hacktoberfest.
-
Respect the Hacktoberfest Code of Conduct.
-
Only submit high-quality code that you have written yourself.
-
Ensure that your code is well-documented and follows best practices.
-
Contributions must be placed in the appropriate category-specific folder.
-
Your code contributions should have a proper name if you're creating a new file. For example:
Let's say you're contributing to the Data Structures & Algorithms folder by solving a LeetCode problem, named Two Sum. Your file name should be two-sum followed by the appropriate extension of the language you're writing the code in.
If you want to submit an entire project, let's say you're contributing a ToDo List app to the Web Development folder. Your folder name should be ToDo list, and all the files relating to the same should be within that folder.
-
Avoid submitting duplicate contributions. Check the existing codebase and issues before making a contribution. Feel free to add alternative language solutions to already existing solutions but with the same name, just a different extension.
-
Be polite and respectful when communicating with other contributors.
-
Your Pull Requests must be approved by maintainers before merging.
This repository has different categories for various types of code contributions. Please choose the appropriate folder for your contribution:
- Data Structures & Algorithms
- Web Development
- Mobile App Development
- Machine Learning
- Data Analysis
- Game Development
- Miscellaneous
To learn any field of tech, we suggest you to go through these following resources:
Beyond the incentives provided by Hacktoberfest and its collaborators, the OWASP NIE Student Chapter is eager to express our appreciation for your open-source dedication. We're delighted to announce that the individual who makes the most impactful contributions to this repository will receive an exclusive cash prize of 1000 INR courtesy of our chapter. The winner will be determined in early November, taking into account both the quantity and quality of their contributions. Your passion for open source can truly pay off!
Ready to get started? Fork this repository, pick a category, and start contributing today! If you have any questions or need assistance, feel free to open an issue or contact the project maintainers.
Project Maintainers -
- Arnav Bhattacharya [email protected] +91 83910 81502
Happy Hacking and Happy Hacktoberfest! 🚀🎉