First off, thank you for considering contributing to My-first-Neo-project! We're excited to have you join our community. Every contribution, no matter how small, helps us build the best academic resource platform for students.
This guide will walk you through the entire contribution process, from setting up your local environment to submitting a polished pull request.
New to Open Source? No problem! This guide is designed to be beginner-friendly. If you get stuck, don't hesitate to open an issue or ask for help.
- Code of Conduct
- License
- Ways to Contribute
- Points & Difficulty Levels
- Contribution Guidelines
- PR review Process
- How To Contribute
- Need More Help
- Attribution
- Thank you for your contribution
We expect all contributors to follow our Code of Conduct.
By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.
By contributing to this project, you agree that your contributions will be licensed under the MIT License.
You can contribute in several ways:
- 🐞 Report Bugs: Submit issues for reproducible bugs.
- 💡 Suggest Features: Propose new ideas or improvements.
- 📖 Improve Documentation: Enhance clarity, grammar, or structure.
- ⚡ Add Code: Fix bugs, build new features, or optimize existing ones.
- 🧪 Test: Help us find issues by testing code in different environments.
Your contributions earn points that count toward GSSoC'25 and your My-first-Neo-project Leaderboard status!
| Difficulty | Points |
|---|---|
| Level 1 | 3 |
| Level 2 | 7 |
| Level 3 | 10 |
Note: The scoring system applies only to GSSOC contributors.
- Code Style: Use clean, readable code with meaningful names.
- UI Consistency: Follow the modern UI style with animated gradients.
- Responsive Design: Ensure changes work on both desktop and mobile.
- Commit Messages: Use descriptive commit messages.
We aim to keep things smooth and transparent:
- Once your PR is submitted, a maintainer will review it.
- You may be asked to:
- Fix styling issues.
- Add missing documentation/tests.
- Break large PRs into smaller pieces.
- After approval:
- Your PR will be merged with a squash merge to keep history clean.
- You’ll receive feedback, even if the PR isn’t merged immediately.
- ⌛ Reviews may take 24–72 hours depending on activity. Thanks for your patience!
For Any Query, Send a DM on LinkedIn Shahid.
- Drop a Star ⭐ in this repo
- Take a look at the existing Issues.
- Fork the Repo & create a branch for any issue that you are working on and commit your work.
- At first raise an issue in which you want to work
- Then after assigning only then work on that issue & make a PR
- Create a Pull Request, which will be promptly reviewed and given suggestions for improvements by the community.
- REMINDER: Don't raise more than 2
Issueat a time - IMPORTANT: Don't make any type of
Pull Requestuntil & unless you get assigned to anIssue - Add screenshots or screen captures to your
Pull Requestto help us understand the effects of the changes that are included in your commits.
You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:
How to create a Issue
Forking a Repo
Cloning a Repo
How to create a Pull Request
Getting started with Git and GitHub
This CONTRIBUTING.md was prepared with ❤️ by Divya Jain for My-first-Neo-project as part of the GSSoC'25 program.
The structure and recommendations follow GitHub Open Source Guides and best practices used in leading open-source repositories.