Contribute Your Project
Help grow our community by adding your final year project to the hub. Follow these simple steps to contribute.
Complete Contributing Guide
Detailed setup instructions, troubleshooting, code guidelines & more
Why Contribute?
- Showcase your work to students and educators worldwide
- Help future students find inspiration for their projects
- Build your portfolio and gain recognition
- Contribute to the open-source community
How to Contribute
Create an Issue First
Before creating a pull request, create an issue to discuss your project addition with the maintainers.
Go to the Issues tab and create a new issue with:
- Title: "Add Project: [Your Project Name]"
- Project Title: Full name of your project
- Description: Brief overview (2-3 sentences)
- Category: Machine Learning, IoT, Web Dev, etc.
- Tech Stack: List main technologies used
- GitHub Repository: Link to your project repo
- Live Link: (Optional) URL to your deployed project or demo
- Contributors: Names of all team members
- Key Features: 3-5 main features of your project
- Project Status: Completed/In Progress
Why create an issue first?
- Allows maintainers to review project details before code submission
- Prevents duplicate project submissions
- Ensures your project meets quality guidelines
- Provides a discussion thread for any questions or clarifications
- Streamlines the PR review process
Example Issue:
Title: Add Project: AI-Powered Code Review System
Description: An intelligent code review system that uses machine learning to analyze code quality, detect bugs, and suggest improvements...
Category: Machine Learning
Tech Stack: Python, TensorFlow, React, Node.js
Fork the Repository
After your issue is acknowledged, fork the Final Year Projects Hub repository to your GitHub account.
# Navigate to the repository
https://github.com/avinash201199/Final-Year-Projects-Hub
# Click the "Fork" button in the top right
Clone Your Fork
Clone the forked repository to your local machine.
git clone https://github.com/avinash201199/Final-Year-Projects-Hub
cd final-year-projects-hub
Create a New Branch
Create a new branch for your project addition.
git checkout -b add-project-your-project-name
Add Your Project Screenshot
Add a high-quality screenshot of your project to showcase its interface and features.
Step 5.1: Prepare Your Image
- Take a clear screenshot of your project (preferably the main interface)
- Recommended dimensions: 1200x800 pixels or similar aspect ratio
- Supported formats: PNG, JPG, or WebP
- Keep file size under 500KB for optimal loading
- Use a descriptive filename (e.g., your-project-name.png)
Step 5.2: Add Image to Repository
# Create the projects folder if it doesn't exist
mkdir -p public/projects
# Copy your screenshot to the projects folder
cp /path/to/your-screenshot.png public/projects/your-project-name.png
Image Guidelines:
- Use kebab-case for filenames (e.g., ai-code-review.png)
- Ensure the image clearly shows your project's key features
- Avoid screenshots with personal or sensitive information
- The image path in JSON will be: /projects/your-filename.png
Add Your Project to projects.json
Open data/projects.json and add your project details following this format:
{
"id": 7,
"title": "Your Project Title",
"description": "A brief description of your project (1-2 sentences)",
"category": "Machine Learning | IoT | Web Dev | Data Science | Blockchain | Mobile Dev",
"techStack": ["Technology1", "Technology2", "Technology3"],
"github": "https://github.com/your-username/your-project",
"live": "https://youre-website-link",
"image": "/projects/your-project-name.png",
"contributors": ["Your Name", "Co-contributor Name"],
"featured": false,
"fullDescription": "A detailed description of your project, its features, and impact (3-4 sentences)"
}Important Notes:
- Use a unique ID (increment from the last project)
- Keep descriptions concise and clear
- Choose the most relevant category
- List 3-5 main technologies in your tech stack
- Ensure your GitHub repository is public
- Image path must match your uploaded file: /projects/your-filename.png
- Set featured to false (admins will feature exceptional projects)
Commit Your Changes
Commit your changes with a clear and descriptive message.
git add public/projects/your-project-name.png
git add data/projects.json
git commit -m "Add [Your Project Name] to projects list"
Push to Your Fork
Push your changes to your forked repository.
git push origin add-project-your-project-name
Create a Pull Request
Go to the original repository and create a pull request from your fork.
- Navigate to the original repository on GitHub
- Click on "Pull Requests" tab
- Click "New Pull Request"
- Click "compare across forks"
- Select your fork and branch
- Add a clear title: "Add [Your Project Name]"
- In the PR description, reference your issue: "Closes #[issue-number]" and briefly describe your project
- Submit the pull request
PR Description Template:
Closes #[issue-number]
This PR adds [Project Name] to the projects hub.
Changes:
- Added project screenshot to public/projects/
- Updated projects.json with project details
Contribution Guidelines
Quality: Ensure your project is complete, well-documented, and functional.
Originality: Submit only your own work or properly credit collaborators.
Documentation: Your GitHub repository should have a clear README with setup instructions.
Code of Conduct: Be respectful and professional in all interactions.
Review Process: Maintainers will review your PR within 3-5 business days.
Need Help?
If you encounter any issues or have questions about contributing, feel free to reach out!