Skip to content
This repository has been archived by the owner on Oct 17, 2023. It is now read-only.

Latest commit

 

History

History
90 lines (65 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

90 lines (65 loc) · 2.92 KB

Guidelines for Contributions 📚

-Before you commence contributing, please familiarize yourself with our Code of Conduct.
-We anticipate all contributors to adhere to these instructions to maintain a positive and inclusive community.

-🎯Initiate an issue regarding the code or contributions you plan to make.
-🎯Browse through existing issues to prevent duplicate submissions.
-🖊Name you files appropriately. Ensure that your file name is unique, and does not previously exist in folder.
-🎯Once assigned, proceed with your contributions and initiate your initial PR.
-🖊 For DSA/CP contributions, give brief explanation of the algorithm and complexities as comments.
-🎯Kindly furnish a brief description of your code or contribution to facilitate learning and enhancement by others.
-🎯Refrain from removing any existing content.
-🎯Do not make changes to existing files.
-🎯Endeavor to keep pull requests concise to mitigate merge conflicts.
-🖊Write a 1-line desciption of your contribution by in the 'Extended Description' section while commiting and making pull request.

Specific Directories

-🧩We have categorized the project into DSA_CP, Theory_Explanation and Games_Tools.
-🧩Select the directory that aligns with your interests.
-🧩Only folders DSA_CP, Theory_Explanation and Games_Tools are open to contributions.

Getting Started 🤩🤗

  • Fork this repo (button on top)
  • Clone on your local machine
git clone https://github.com/akanksha1331/DSA_CP_Hacktoberfest23.git
  • Navigate to project directory.
cd DSA_CP_Hacktoberfest23
  • Create a new Branch
git checkout -b my-new-branch
  • Make your changes folderName/fileName

  • Add your changes

git add .
  • Commit your changes.
git commit -m "Relevant message"
  • Then push
git push origin my-new-branch
  • Create a new pull request from your forked repository

Avoid Conflicts {Syncing your fork}

An easy way to avoid conflicts is to add an 'upstream' for your git repo, as other PR's may be merged while you're working on your branch/fork.

git remote add upstream https://github.com/akanksha1331/DSA_CP_Hacktoberfest23

You can verify that the new remote has been added by typing

git remote -v

To pull any new changes from your parent repo simply run

git merge upstream/main

This will give you any eventual conflicts and allow you to easily solve them in your repo. It's a good idea to use it frequently in between your own commits to make sure that your repo is up to date with its parent.

git merge upstream/main

This will give you any eventual conflicts and allow you to easily solve them in your repo. It's a good idea to use it frequently in between your own commits to make sure that your repo is up to date with its parent.