Skip to content

Latest commit

 

History

History
122 lines (84 loc) · 5.44 KB

CONTRIBUTING.md

File metadata and controls

122 lines (84 loc) · 5.44 KB
Raw

✨ Contributors Guide ✨

Welcome to my Web Development project! 😍
We appreciate your interest in contributing.😊
This guide will help you get started with the project and make your first contribution.

Line

What you can Contribute?

🐞Bug Fixing : Contributors can help by reviewing and confirming reported issues. This includes verifying bugs, providing additional details, and prioritizing tasks for the development team.

✨Enhancements : Contributors can enhance the project by implementing new features or improvements suggested by users. This involves understanding requirements, designing solutions, and extending the functionality of the travel website. 🚀

Line

How to Contribute?

  • Drop a Star ⭐ in this repo

  • Take a look at the existing Issues.

  • Fork the Repo & create a branch for any issue that you are working on and commit your work.

  • At first raise an issue in which you want to work

  • Then after assigning only then work on that issue & make a PR

  • Create a Pull Request, which will be promptly reviewed and given suggestions for improvements by the community.

  • REMINDER: Don't raise more than 2 Issue at a time

  • IMPORTANT: Don't make any type of Pull Request until & unless you get assigned to an Issue

  • Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes that are included in your commits.

    Line

Submitting a Pull Request?

1. Start by forking the GGExtensions repository. Click on the symbol at the top right corner.

2. Clone your forked repository:

git clone https://github.com/Your-Username/GGExtensions.git

3. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/Your-Username/GGExtensions.git

4. Check the remotes for this repository.

git remote -v

5. Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository).

git pull upstream main

6. Create a Branch: Create a new branch for your changes:

git checkout -b my-feature

7. Make Changes: Make your desired changes to the codebase.

git add .
git add <filename>

8. Commit Changes: Commit your changes with a descriptive commit message:

git commit -m "Add new feature"

9. Push Changes: Push your changes to your forked repository:

git push origin my-feature

10. Submit a Pull Request: Go to your forked repository on GitHub and submit a pull request. Be sure to provide a detailed description of your changes and why they are necessary.

11. Congratulations! You've made your first contribution! 🙌🏼

Alternatively contribute using GitHub Desktop

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

  • Go to the GitHub website and navigate to your fork of the repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the repository.

Thank you for contributing💗