Skip to content

Latest commit

 

History

History
114 lines (78 loc) · 4.16 KB

CONTRIBUTING.md

File metadata and controls

114 lines (78 loc) · 4.16 KB
Raw

🎃 HacktoberFest is here 🎃

Use this project to make your first contribution to an open source project on GitHub. Practice making your first pull request to a public repository before doing the real thing!

Celebrate Hacktoberfest by getting involved in the open source community by completing some simple tasks in this project.

https://github.com/GDSC-TMSL/ProjectAlgorithms/

What is Hacktoberfest?

A month-long celebration from October 1st - 31st sponsored by Digital Ocean and GitHub to get people involved in Open Source. Create your very first pull request to any public repository on GitHub and contribute to the open source developer community.

https://hacktoberfest.digitalocean.com/

What is this project?

Project Algorithms

A place where you can find solutions to the most asked interview questions.

You can contribute by adding new questions and their solutions to the repository.

Contribution in short

  1. Check if the question your adding already exists.
  2. If not, then go to issues and see if someone has added an issue raising the same issue.
  3. If you see that no such issue exists then make a new issue. Make sure to mention which questions your adding and the links to Your solutions.
  4. After having the new issue has been assigned to you, start working on the same. Make sure to follow the rules after this section. Maintain the structure of the repository. If the structure is not maintained then the PR might not be accepted.
  5. Send a PR. Do mention which Issue you solved by referencing it with a # and then typing the name of your issue.
  6. Make the steps below to get more details and a walkthrough of the PR process.

How to contribute to this project

Here are 3 quick and painless steps to contribute to this project:

  • Make a new issue under (check if the same issue is open before checking that).
  • Wait for you to be assingned the issue.
  • Once assingned, you can make the changes you need and send a PR this way. After reviewing of the code, we will merge it.

Getting started

  • Fork this repository (Click the Fork button in the top right of this page, click your Profile Image)
  • Clone your fork down to your local machine
git clone https://github.com/your-username/ProjectAlgorithms.git
  • Create a branch
git checkout -b branch-name
  • Make your changes (choose from any task below)
  • Commit and push
git add .
git commit -m 'Commit message'
git push origin branch-name
  • Create a new pull request from your forked repository (Click the New Pull Request button located at the top of your repo)
  • Wait for your PR review and merge approval!
  • Star this repository if you had fun!

Some things to keep in mind.

1. Add some feature/ Improve existing feature.

Usually when you feel the project is missing something, you want to add some feature.

#### How to make a good issue.
- Identify the problem.
- See if a same issue has already been created.
- Issue Name: Make a apt but compact name.
- Issue Desription: Why did you make this issue? What was the repo missing.
- Finally: How did you fix the issue.

2. Branch Names

When making a branch with git checkout -b "new-branch", keep these things in mind.

# Branch Name
Name the branch something short but apt. It cannot have spaces.

3. Get Coding

Let your inner code show its colours. Do keep these in mind.

# Commit messages
The commit messages must be a small description of what you are trying to fix, add or remove. Its usually around 5-15 words.

Shoutout to our awesome contributors