Skip to content

Latest commit

 

History

History
42 lines (34 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

42 lines (34 loc) · 2.43 KB
Raw

Contributing

You can contribute to this repo in any of the following ways

Adding new problems and solutions

  • If you are selecting a problem from a website like hackerrank, codechef etc

    • Add it to the respective folder (eg: CodeChef_problems; if it doesn't exist, create it)
    • Make a folder with the name as name of the problem given
    • Should have 2 files: problem.md and solution
    • Add the link to the problem in problem.md file
    • Add your solution in any language
    • Solutions must be properly indented and explained with comments

  • If you are submitting a new problem

    • Add it to misc folder
    • Make a folder with name as name of the problem
    • Should have 2 files: problem.md and solution
    • In problem.md, provide detailed explanation of problem statement and constraints with at least 2 testcases and it's explanation
    • Add your solution in any language
    • Solutions must be properly indented and explained with comments

Adding solutions to existing problems

  • You can contribute your solutions to any problem
  • Add it as a new file in the format solution_number eg: (solution2) in the respective problem folder
  • Solutions must be properly indented and explained with comments

Documentation Contributions

  • You can add useful resources related to CP. Refer issue #327
  • You can improve the readme and contributing documentation

Important Note: READ THIS BEFORE SENDING A Pull Request

The idea is to collect different solutions/logic in different languages to some of the popular CP questions.
Read the following points carefully

  • The problem file should only contain either the link to the problem OR the problem itself. DON'T add anything related to the solution in the problem file.
  • In your solution, ADD THE LOGIC USED FOR SOLVING IN THE FORM OF COMMENTS EITHER ALONG WITH THE CODE or AT THE BEGINNING OF THE CODE. (if possible include the Time and Space complexities also)
  • Use proper naming for variables. The variable name should be self explanatory. (avoid using a,b,c,i,j,x,y etc)
  • More emphasis is given on understanding the logic used to get the solution rather than the code itself. Hence simply copy-pasting code is not encouraged. Any solution you add must be your own and not plagiarized in any manner.

As long as your PR adheres with all the points mentioned above, you're good to go ✨

Happy contributing 😃