Welcome to the Mozilla Campus Club of SLIIT Official Website repository! 🚀 This is the source code for our club's website, built using Next.js.
We appreciate contributions from everyone! If you want to improve the website, fix issues, or add new features, follow the guidelines below to get started.
First, fork the repository to your GitHub account and then clone it locally.
# Fork the repo (click the 'Fork' button on GitHub)
# Clone the forked repo
$ git clone https://github.com/YOUR-USERNAME/official-web.git
$ cd official-web
Ensure you have Node.js (LTS version) and npm/yarn installed. Then, run:
# Using npm
$ npm install
# OR using yarn
$ yarn install
# Start the Next.js development server
$ npm run dev
# OR using yarn
$ yarn dev
By default, the website will be available at http://localhost:3000
.
- Browse the Issues section.
- Look for
good first issue
orhelp wanted
labels for beginner-friendly tasks. - If you want to work on an issue, comment on it to get assigned.
Once assigned, create a new branch for your work:
$ git checkout -b feature/your-feature-name
Make your changes and test them locally. Follow Conventional Commits for commit messages.
Example:
$ git add .
$ git commit -m "feat: added a new about section"
$ git push origin feature/your-feature-name
Go to the GitHub repository, open a Pull Request (PR) from your branch, and add a short description.
- Follow the Next.js coding style.
- Ensure proper indentation and use Prettier for formatting:
# Format the code
$ npm run format
- Avoid large PRs; make atomic commits.
If you have any questions:
- Check the existing issues or discussions.
- Reach out to the Mozilla Campus Club of SLIIT team.
- Open a new issue if needed.
Thank you for contributing to the Mozilla Campus Club of SLIIT website! 🙌