Skip to content

Latest commit

 

History

History
164 lines (122 loc) · 6.29 KB

CONTRIBUTING.md

File metadata and controls

164 lines (122 loc) · 6.29 KB
Raw

Contributing Guidelines 📄

This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small.
Please note we have a code of conduct please follow it in all your interactions with the project.

Contribution

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  • If you have any suggestions for the project, such as reporting a bug, improving the UI, or enhancing the README.md file, feel free to open an issue to discuss it or directly create a pull request with the necessary changes.
  • Please make sure to check your spelling and grammar.
  • Create individual pull requests for each suggestion to keep changes focused and manageable.

Your involvement helps to improve the project and make it better for everyone. Thank you for your contributions!

How to Contribute ?

  1. Star the Repo

  2. Fork the Project:

    • Click on the "Fork" button at the top right corner of the repository's page on GitHub to create your own copy of the project.

  3. Clone Your Forked Repository:

    • Clone the forked repository to your local machine using the following command:
     git clone https://github.com/<your_user_name>/SwapReads
    • Navigate to project folder:
     cd SwapReads

  4. Install npm packages:

    npm install

  5. Run index.html with any browser (example: chrome etc).

  6. Add a reference(remote) to the original repository:

    git remote add upstream https://github.com/anuragverma108/SwapReads

  7. Check the remotes for this repository.

    git remote -v

  8. 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

  9. Create a New Branch and Move to the Branch:

    • Create a new branch for your changes and move to that branch using the following commands:
    git checkout -b <branch-name>

  10. Add Your Changes:

    • After you have made your changes, check the status of the changed files using the following command:
    git status -s
    • Add all the files to the staging area using the following command:
    git add .

    or add specific files using:

    git add <file_name1> <file_name2>

  11. Commit Your Changes:

    • Commit your changes with a descriptive message using the following command:
    git commit -m "<EXPLAIN-YOUR_CHANGES>"

  12. Push Your Changes:

    • Push your changes to your forked repository on GitHub using the following command:
    git push origin <branch-name>

Creating Pull Request

  1. Open a Pull Request:
    • Go to the GitHub page of your forked repository, and you should see an option to create a pull request. Click on it, provide a descriptive title and description for your pull request, and then submit it.

Alternatively contribute using GitHub Desktop

  1. Open GitHub Desktop:

    • Launch GitHub Desktop and log in to your GitHub account if needed.

  2. Clone the Repository:

    • If you haven't cloned the SwapReads repository yet, click on the "File" menu and select "Clone Repository."
    • Choose the SwapReads repository from the list and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you're on the branch you want to submit a pull request for.
    • If needed, switch branches by clicking on the "Current Branch" dropdown and selecting the appropriate branch.

  4. Make Changes:

    • Edit the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of changed files. Check the box next to the files you want to commit.
    • Enter a summary and description for your changes, then click "Commit to [branch name]" to commit to your local branch.

  6. Push Changes to GitHub:

    • After committing, click "Push origin" 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 GitHub, navigate to your fork of the SwapReads repository, and click "Compare & pull request."

  8. Review and Submit:

    • On the pull request page, review your changes and add any necessary information (title, description, etc.).
    • When ready, click "Create pull request" to submit.

  9. Wait for Review:

    • The project maintainers will review your pull request. They may provide feedback or request changes before merging it into the main SwapReads repository.

Issue Report Process 📌

  1. Go to the project's issues.
  2. Give proper description for the issues.
  3. Don't spam to get the assignment of the issue 😀.
  4. Wait for till someone is looking into it !.
  5. Start working on issue only after you got assigned that issue 🚀.

Pull Request Process 🚀

  1. Ensure that you have self reviewed your code 😀
  2. Make sure you have added the proper description for the functionality of the code
  3. I have commented my code, particularly in hard-to-understand areas.
  4. Add screenshot it help in review.
  5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀

Need some help regarding the basics?🤔

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:

Thank you for contributing💗