Skip to content

Latest commit

 

History

History
162 lines (114 loc) · 7.8 KB

CONTRIBUTING.md

File metadata and controls

162 lines (114 loc) · 7.8 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 projects (doesn't matter which language) to this Repository.

Code of Conduct

Please read and follow our Code of Conduct.

Before contributing, please ensure that your pull request adheres to the following guidelines:

STEP-0: Key Points to remember :

  • Look at the previous projects and get some idea from them Previous

  • Suppose you want to contribute one project to one particular domain then first check if there are any Projects exits with the same language or not.

  • If Yes that your project already exists with the same programming language then you can't be able to add your project to this repo.

  • If there is no such project then make sure you enter your particular domain and create one folder and the folder name should be your project name.

  • Please don't add any Licenses to your project. This repo is already under MIT License.

    Flow :

    • Project-Guidance --> Choose your domain --> Choose your project level (basic, Intermediate, advanced) --> Create a folder with your project name --> Send a pull request.

png

STEP-1 : Find an issue

  • Take a look at the Existing Issues and Pull Requests as yours may be a duplicate or create your own Issues!

  • Wait for the Issue to be assigned to you after which you can start working on it.

  • See the following images:

Fork the repository by clicking on Fork button 👇

Fork-image-new



Clone the repository by clicking on Code button 👇

Clone-Link-Image

"Then click on the clipboard icon and follow the below commands"

Step 2 : Fork the Project

  • Fork this Repository. This will create a Local Copy of this Repository on your Github Profile. Keep a reference to the original project in upstream remote.
$ git clone https://github.com/<your-username>/<repo-name>  
$ cd <repo-name>  
$ git remote add upstream https://github.com/<upstream-owner>/<repo-name>
  • If you have already forked the project, update your copy before working.
$ git remote update  
$ git checkout <branch-name>  
$ git rebase upstream/<branch-name>

Step 3 : Choose your domain.

  • Create a branch :
$ git branch <branch-name>
$ git checkout <branch-name>
  • Add your projects to a folder and the folder name should be your project .
  • Add all the files/folders needed.
  • After you've made changes or made your contribution to the project add changes to the branch you've just created by:
# To add only a few files to Branch_Name
$ git add <some files>
# To add only a few files to Branch_Name
$ git add <some files>

Step 4 : Commit

  • To commit give a descriptive message for the convenience of reviewer by:
  • Please make an individual commit for each suggestion in a separate pull request.
  • Check your spelling and grammar.
  • Remove any trailing whitespace.
# This message get associated with all files you have changed  
$ git commit -m "message"

Step 5 : Work Remotely

  • Now you are ready to your work to the remote repository.
  • When your work is ready and complies with the project conventions, upload your changes to your fork:
# To push your work to your remote repository  
$ git push -u origin Branch_Name

Step 6 : Pull Request

  • Go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution.
  • Make sure your PR easy to review. That means having a clear description and only touching code that's necessary for your change.
  • Check your spelling and grammar.
  • Remove any trailing whitespace.

Note :

  • New categories, or improvements to the existing categorisation, are always welcome.
  • Being an open source contributor doesn't just mean writing code, either. You can help out by writing documentation, tests, or even giving suggestions. 🏆

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 Project-Guidance repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
  • Choose the Project-Guidance 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.
  1. Make Changes:
  • Make your changes to the code or files in the repository using your preferred code editor.
  1. 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.
  1. 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.
  1. Create a Pull Request:
  • Go to the GitHub website and navigate to your fork of the Project-Guidance 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.
  1. 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 Project-Guidance repository.

Need more help?🤔

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

Tip from us😇

It always takes time to understand and learn. So, do not worry at all. We know you have got this!💪