CONTRIBUTE

SDGP.LK
Open Source Contributions

Help improve SDGP Connect. You can contribute with code, bug reports, documentation, design feedback, or simple suggestions.

What is SDGP Connect?

sdgp.lk is a platform built for the Informatics Institute of Technology (IIT) as part of the SDGP (Software Development Group Project) module. Its core mission is to showcase student-led tech projects and connect them with real-world investors, mentors, and industry partners.

SDGP Connect helps students go beyond academic recognition and attract funding, incubation, or partnerships that can help bring their projects to life.

How to Contribute

Contributions can be in many forms. Bug reports, feature suggestions, documentation improvements, design feedback, and code changes all help. If you plan to work on a GitHub issue, request assignment first so we can avoid duplicate work and agree on the approach.

Why Contribute?

Help Students

Your improvements directly help SDGP teams submit, showcase, and get feedback on their work.

Learn on a Real Codebase

Work with a production Next.js app, Prisma, and real review feedback through pull requests.

Build Your Portfolio

A merged PR is a concrete contribution you can show. Even small fixes add up.

Ways to Contribute (Not Only Code)

Report Bugs

Clear steps to reproduce, screenshots, and logs help us fix issues faster.

Suggest Improvements

UX feedback, feature ideas, and edge cases are valuable. Open an issue and explain the problem.

Improve Docs and Content

Fix unclear instructions, add examples, or improve page content. These changes help everyone.

Working on a GitHub Issue (Code Changes)

1. Request Assignment

Find an issue and comment asking to be assigned. In your comment, include your approach (how you plan to solve the problem) so maintainers can review quickly.

https://github.com/IIT-SDGP/SDGP-Connect/issues

Start work only after a maintainer assigns the issue to you.

2. Fork & Create a Branch

Fork the repository on GitHub, then clone your fork and create a branch for the issue.

git clone https://github.com/<your-username>/SDGP-Connect.git
git checkout -b fix/issue-123-short-title
3. Open a Pull Request

Push your branch to your fork and open a PR back to our main branch. We'll review it and merge once approved.

git push -u origin fix/issue-123-short-title

Make sure your PR references the issue and explains what changed and why.

Local Development Setup (How to Code)

1. Clone Your Fork

Clone your fork locally:

git clone https://github.com/<your-username>/SDGP-Connect.git
cd SDGP-Connect
2. Install Dependencies

Install packages (we use Yarn):

yarn install

Tip: Keep your branch small and focused on the issue.

3. Run Locally

Start the dev server:

yarn dev

If you run into env/database setup, check the repo README.

For full documentation and repository details, visit https://github.com/IIT-SDGP/SDGP-Connect.

Join Our Community

Connect with fellow developers, get support, and collaborate on exciting projects.

Join Our Community
Help us on other aspects of the project.

Connect with us on WhatsApp to discuss ideas, get support, and collaborate.

Join WhatsApp Community
Explore Our Code
Dive into the codebase and see how you can contribute.

Access the SDGP Connect repository on GitHub for issues, discussions, documentation, and code.

Visit GitHub Repository

Reporting Website Issues

Opening an Issue
Report bugs, request features, or suggest improvements.

Issues are tracked here: https://github.com/IIT-SDGP/SDGP-Connect/issues. Please check this list before opening a new issue.

Submit Bug Report or Feature Request

Repo: https://github.com/IIT-SDGP/SDGP-Connect

Reporting Security Issues
Your security is our priority.

Please do not report security issues via GitHub issues. Instead, email your reports to: security@sdgp.lk.

Email Security Team