Welcome to EasyGoDocs!
First off, thank you for considering contributing to EasyGoDocs! 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
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.License
By contributing to this project, you agree that your contributions will be licensed under the MIT License.Ways to Contribute
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
Points & Difficulty Levels
Your contributions earn points that count toward GSSoC’25 and your EasyGoDocs Leaderboard status!| Difficulty | Points |
|---|---|
| Level 1 | 3 |
| Level 2 | 7 |
| Level 3 | 10 |
The scoring system applies only to GSSOC contributors.
Contribution Guidelines
Please follow these guidelines when contributing:- 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
PR Review Process
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
How To Contribute
Star the Repository
Drop a star on the EasyGoDocs repository to show your support!
Find an Issue
Take a look at the existing Issues and find one that interests you.At first, raise an issue for the work you want to do. Then wait for assignment before starting work.
Work on Your Changes
After being assigned, work on the issue and commit your changes with clear, descriptive commit messages.Add screenshots or screen captures to help us understand the effects of your changes.
Create Pull Request
Create a Pull Request, which will be promptly reviewed and given suggestions for improvements by the community.
Need More Help?
You can refer to the following articles on basics of Git and GitHub:- How to create an Issue
- Forking a Repo
- Cloning a Repo
- How to create a Pull Request
- Getting started with Git and GitHub
Attribution
This contributing guide was prepared with care by Divya Jain for EasyGoDocs 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.Thank you for contributing to EasyGoDocs!
We can’t wait to see what you build!