Thank you for your interest in contributing to SkillLink! 🎉
This project is a platform that helps students develop their portfolios through collaboration with industry.
This guide explains the standard steps for contributing to ensure that collaboration runs smoothly and efficiently.
SkillLink/
├── api/ # Backend (Next.js API)
├── web/ # Website (Next.js)
├── mobile/ # Mobile App (React Native)
└── README.md
- Fork this repository to your GitHub account.
- Clone the fork to your local machine:
git clone https://github.com/KodingMulu/SkillLink.git
cd SkillLink
- Create a new branch for features or improvements:
git checkout -b feature/feature-name - Make changes in the folder according to your responsibilities:
- /api → for the backend
- /web → for the website
- /mobile → for mobile applications
- Commit your changes with a clear message:
git add . git commit -m “feat(mobile): adding login page” - Push to the branch in your fork repo:
git push origin feature/feature-name - Open a Pull Request (PR) to the main branch in the main repository. Ensure the PR description clearly explains what you have changed.
- All PRs will be reviewed by the main admin/maintainer.
- At least 1 approval is required before it can be merged into the main branch.
- Make sure there are no conflicts before submitting a PR.
- Do not merge PRs yourself without the reviewer's approval.
Use consistent commit messages:
- feat: for new features
- fix: for bug fixes
- docs: for documentation updates
- refactor: for code structure improvements
Before pushing, make sure the code is:
- Error-free (npm run lint or npm run build)
- Follows the project style
If you encounter any issues or need assistance, create a new issue in the Issues tab, or contact the project's primary maintainer.
Thank you for contributing! Every little contribution helps SkillLink become better 🚀