Welcome to Group Study! I appreciate your interest in contributing to this full-stack Next.js project.
Before you start contributing, please take a moment to read the following guidelines to ensure a smooth and effective contribution process.
- You should have Node.js and MongoDB installed on your local machine.
- Fork the repository on GitHub.
- Clone your forked repository locally:
git clone https://github.com/<your_username>/Group-Study.git - Change your directory to the project:
cd Group-Study - Add a reference to the original repository:
git remote add upstream https://github.com/Aditya61101/Group-Study.git - Check the remotes for this repository:
git remote -v - Always take a pull from the upstream repository to your main branch to keep it updated as per the main project repository:
git pull upstream main - Create a new branch (prefer a branch name that relates to your assigned issue):
git checkout -b <YOUR_BRANCH_NAME> - Install project dependencies:
npm install
If you are reporting an issue, please ensure that it's not already present in Issues. Otherwise, you can open a new issue and provide detailed information about the issue.
Feel free to share your suggestions for improvements. Before opening a new enhancement request, please check the existing issues to see if your idea has been discussed. If it's not already addressed, you can submit a new issue and provide details about your enhancement proposal.
Feel at liberty to choose any open matter from our issue tracker that captures your interest. Express your intention to address the chosen issue by commenting on it, ensuring transparency with other contributors. If additional information is required for a specific issue, feel free to seek clarification.
- Check your changes:
git statusthengit diff - Stage your changes:
git add . <\files_that_you_made_changes> - Commit the changes:
git commit -m "relevant message" - Push the committed changes in your feature branch to your remote repository:
git push -u origin <your_branch_name> - To create a pull request, click on compare and pull requests.
- Also, upload a video snippet or at least a screenshot of the thing that you have done.
- Be willing to make any requested changes or improvements.