Skip to content

Latest commit

 

History

History
114 lines (91 loc) · 7.05 KB

CONTRIBUTING.md

File metadata and controls

114 lines (91 loc) · 7.05 KB

🎇Contributing Guidelines


First of all thanks for taking time out to contribute 😃 🥳

This documentation contains a set of guidelines to help you during the contribution process.

💻Before Contributing

Welcome to Riddhi9570/HackerrankPracticeProblems. Before sending your pull requests, make sure that you read the whole guidelines. If you have any doubt about the contributing guide, please feel free to reach out.

🙌Contribution

Your contributions can be adding a solution to a new practice problem of the existing domain (SQL) or you can come up with the solution of any other domain (For example, C++, Java, Python, etc.). Please read this section if you are contributing your work.

🔖Steps to Contribute

Following are the steps to guide you:

  • Step 1: Star and Fork the repo Go to your Git terminal and clone it on your machine.
  • Step 2: Add an upstream link to the main branch in your cloned repo
    git remote add upstream https://github.com/Riddhi9570/HackerrankPracticeProblems.git
    
  • Step 3: Keep your cloned repo up to date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)
    git pull upstream main
    
  • Step 4: Create your feature branch (This is a necessary step, so don't skip it)
    git checkout -b <feature-name>
    
  • Step 5: Commit all the changes (Write commit message as "Small Message")
    git commit -m "Write a meaningful but small commit message"
    
  • Step 6: Push the changes for review
    git push origin <branch-name>
    
  • Step 7: Create a PR on Github. (Don't just hit the create a pull request button, you must write a PR message to clarify why and what are you contributing)

🔑Guidelines

Here are some set of guidelines to follow while contributing to HackerrankPracticeProblems :

  1. Welcome to this repository, if you are here as an open-source program participant/contributor.
  2. Participants/contributors have to comment on issues they would like to work on, and mentors or the PA will assign you.
  3. Issues will be assigned on a first-come, first-serve basis.
  4. Participants/contributors can also open their issues, but it needs to be verified and labelled by a mentor or PA. We respect all your contributions, whether it is an Issue or a Pull Request.
  5. When you raise an issue, make sure you get it assigned to you before you start working on that project.
  6. Each participant/contributor will be assigned 1 issue (max) at a time to work.
  7. Don't create issues that are already listed.
  8. Please don't pick up an issue already assigned to someone else. Work on the issues after it gets assigned to you.
  9. Create your file in an appropriate folder with appropriate name and extension.
  10. When you are adding solution for a hackerrank problem, add these comments at the top your solution:
  • -- # Problem Link : < problem link >
    For example,
    -- # Problem Link: https://www.hackerrank.com/challenges/multi-level-inheritance-cpp/problem
  • -- # Problem : < problem name >
    For example,
    -- # Problem : Multi Level Inheritance
  • -- # Language : < programming language >
    For example,
    -- # Language : C++
  • -- # Subdomain : < subdomain of problem in hackerrank >
    For example,
    -- # Subdomain : Inheritance
  • -- # Max Score : < Maximum score for that problem >
    For example,
    -- # Max Score : 25
  • -- # Difficulty : < Easy/Medium/Hard >
    For example,
    -- # Difficulty : Easy
  1. It would be appreciated if you add approach and notes to your solution (especially for difficult problems)- Example 1, Example 2.
  2. Create a pull request and also give your hackerrank submission link in the description so that it can be easily reviewed and merged.
  3. Pull requests will be merged after being reviewed by a mentor or PA.
  1. We all are here to learn. You are allowed to make mistakes. That's how you learn, right!.

🧲Pull Requests Review Criteria

  • You must add your file into the respective folder.
  • Your work must be original, written by you not copied from other resources.
  • You must comment on your code wherever necessary.
  • Follow the proper style guides for your work.
  • For any queries or discussions, please feel free to drop a message.

📖Resources

  1. Markdown: Markdown is a lightweight markup language like HTML, with plain text formatting syntax.
  1. Git: Git is a distributed version control system for tracking changes in source code during software development. It is designed for coordinating work among programmers, but it can be used to track changes in any set of files.

🤔Need more help?

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

😇Tip from me

It always takes time to understand and learn. So, do not worry at all. I know you can do this**!💪

Typing SVG