This interactive tutorial will guide you through the process of making a pull request to contribute to this project. Follow the steps carefully and don't hesitate to ask for clarification if you encounter any issues.
- Fork this repository to your GitHub account by clicking the "Fork" button in the top-right corner of the repository page.
- Clone the forked repository to your local machine:
git clone https://github.com/YOUR_USERNAME/Xplore.git
Replace YOUR_USERNAME
with your actual GitHub username.
- Navigate to the project directory:
cd Xplore
- Create a new branch for your changes:
git checkout -b feature/your-feature-name
Replace your-feature-name
with a descriptive name for your feature or change.
🚨 **Potential Issue:** If you encounter an error saying `fatal: not a git repository`, it means you're not in the correct directory. Navigate to the `Xplore` directory and try again.
-
Make your desired changes to the codebase using your favorite code editor.
-
Stage your changes:
git add .
This command stages all the changes you've made.
- Commit your changes with a descriptive message:
git commit -m "Add feature xyz"
Replace "Add feature xyz"
with a concise description of your changes.
🚨 **Potential Issue:** If you encounter an error saying `nothing added to commit but untracked files present`, it means you have new files that haven't been staged. Run `git add .` again and then commit your changes.
- Push your changes to your forked repository:
git push origin feature/your-feature-name
Replace your-feature-name
with the name of your branch.
🚨 **Potential Issue:** If you encounter an error saying `remote origin already exists`, you may need to set the upstream repository by running:
git remote add upstream https://github.com/SharanRP/Xplore.git
Then try pushing your changes again.
- Visit your forked repository on GitHub.
- Switch to the branch you just pushed by clicking on the "Branch" dropdown and selecting your branch.
- Click on the "New Pull Request" button.
-
Provide a descriptive title and description for your pull request, explaining the changes you've made and their purpose.
-
Click on the "Create Pull Request" button to submit your pull request.
🎉 Congratulations! You've successfully created a pull request. The project maintainers will review your changes and provide feedback or merge them into the main repository.
Please add your name and registration number below:
- Name: [Your Name]
- Registration Number: [Your Registration Number]