Skip to content

Latest commit

 

History

History
80 lines (67 loc) · 3.34 KB

CONTRIBUTING.md

File metadata and controls

80 lines (67 loc) · 3.34 KB

Contribution Guide

First of all, I would like Thank you for showing interest as I greatly appreciate your efforts towards making this project better.

How to setup?

This is the most simple project when it comes to contributions, setup, opening issues/pull requests + you get to practice competitive questions.

So let's get started.

  • Clone the repo using the command git clone https://github.com/sunnysetia93/competitive-coding-problems.git
NOTE: Programming Language is not a constraint. Pseudo code (in form of comments) is also appreciated as It can be solved by one of us later.

How to pick up an Issue

  • Comment on the issue first so that we can assign you the issue.
  • If you raise a Pull Request for an issue and the Issue was not assigned to you, your PR will be marked as Invalid

Submittng a Pull Request (PR)

  • Add yourself to the assignee section
  • Add meaningful heading and description to your PR
  • Also mention the issue number in the description using '#', e.g: #12
  • Not following the above will mark your PR invalid

Adding your code

  • When adding a new problem with a solution
    • A problem statement should be there in form of comments and support it with some examples (Refer this Example)
    • It would be great if you can mention the Run Time Complexity of your solution
    • Please take care of the segregation of the Problems as per the given Folder Structure
    • It's great if you can add the Unit Tests to verify your solutions as well.
  • When adding a Unit Test
    • Take care of the file name convention

Folder Structure (Example Folder - LeetCode)

File name to be followed:

eg: 445.add-two-numbers-II.js

  1. here 445 is the official problem number from leetcode
  2. name should be in Kebab Case. (dash/hyphen(-) in between words)
LeetCode
├── All
│   ├── languageName
│   │   ├── problemNo.name-of-the-problem.languageExtension
├── Challenges
│   ├── Month_LeetCoding_Challenge
│   │   └── languageName
│   │       ├── problemNo.name-of-the-problem.languageExtension
├── Contests
│   ├── Biweekly Contest ##
│   │   └── languageName
│   │       ├── problemNo.name-of-the-problem.languageExtension
│   ├── Weekly Contest ##
│   │   └── languageName
│   │       ├── problemNo.name-of-the-problem.languageExtension
├── Difficulty
│   ├── Easy
│   │   └── languageName
│   │       ├── problemNo.name-of-the-problem.languageExtension
│   ├── Hard
│   │   └── languageName
│   │       ├── problemNo.name-of-the-problem.languageExtension
│   └── Medium
│   │   └── languageName
│   │       ├── problemNo.name-of-the-problem.languageExtension
├── Tag
│   ├── Tag Name
│   │   └── languageName
│   │       ├── problemNo.name-of-the-problem.languageExtension

Notes

  • Keep an eye on this guide, it's subjected to change frequently.
  • Todo
    • Unit Test cases for Questions already solved.
    • Optimizing the logic.
    • Issue Template
    • PR Template