Skip to content

Latest commit

 

History

History
91 lines (34 loc) · 3 KB

newContributors.md

File metadata and controls

91 lines (34 loc) · 3 KB
Raw

Hello Peeps 👋

Welcome to the kidney-exchange Repo 🎉

Here, is the Complete Guide to Contribute to this Repo.

📌⚠️Git Essentials⚠️📌

If You don't have Git already installed on your System ,You can follow this Installation_Guide.


  1. Firstly, Join our Discord Server, Introduce yourself there, Interact with Others as

    Open Source is more about Collaboration.

  2. You can look through the good first issues and select the one that you like to work on. If your interested issue is already assigned to someone, you can also collaborate to get it done.

  3. If none of the issues match your interest or things are a bit overwhelming, you can ask for guidance in the discord group.

  4. So to start Contributing to our Project you can solve existing issues or if you have found any bugs or want to add a new feature to Project you can create New Issue, that's purely your choice.

  1. Project Maintainers and Mentors will guide you with the issue and incase of any problem you face, you can take help from the community in the discord server.

  2. So, Now you have an issue to work upon. So first you need is to fork Repo. "Fork means producing a Personal Copy of Someone else's Project". You can fork Repo This Way:-

  1. Clone the Repo you have forked:-

    • Copy the link of the forked Repo.

    • Go to the desired location in the terminal, where you want to place the project.

    • Run command git clone https://github.com/<github username>/kidney-exchange.git

    • Run Command cd kidney-exchange

    • Open the folder with your favorite text editor command.

  2. Set upstream to the Repo Using Command git remote add upstream https://github.com/siv2r/kidney-exchange.

  3. Make a branch using the command git checkout -b branch_name .

  4. Now it is the time to make required changes in the project 🌸

  5. When you are done with the changes, Run following Commands:-

    • git add .

    • git commit -m "any_message_related_to_what_u_hv_done"

    • git push origin branch_name

  6. Go to your forked Repo in Github, there you will see a notification for Compare and Pull Request like this:-
    Click this and create your First Pull Request.

  7. Mentors will review your changes and will give feedback and if everything goes well, your PR will get merged, Hurray 🎉🥳

  8. So Now your PR Got Merged 🎉, Again Find or Create Issue and Continue the loop of Contributions to this Project

Happy Coding 💻