Skip to content

Latest commit

 

History

History
48 lines (43 loc) · 1.97 KB

CONTRIBUTION.md

File metadata and controls

48 lines (43 loc) · 1.97 KB

Contributing guidlines for Algo_Ds

Thanks for taking the time to contribute to this project. Before making PRs, please note the following:

Few norms you can follow

  • Proper intendation is must
  • Proper commenting should be there to make code readable
  • You may mention complexity of a function in comment
    • Time complexity :
    • Space complexity :
  • Place your code in right directory
  • Naming of your file must be proper and relevant

You may add your solved questions on spoj, codechef, hackerearth, hackerrank and codeforces.

  • First line of your code must begin with a comment mentioning the link of the question
  • Place the solutions in seperate folder "ques" in relevant directory

DESCRIPTION.md

If not already present, you are free to create a DESCRIPTION.md file in a folder

  • Please write a brief description of your algorithm in DESCRIPTION.md file
  • You can mention the following points:
    • Description of your algorithm
    • Time and space complexity of your algorithm
    • Links to your favourite online questions solvable by that algorithm
    • You may also provide solution to that questions in "ques" folder in the same directory
    • Also mention link of solution(if available) along with the question link

Best Practice of creating a Pull Request

  • The PR name should be meaningful.
  • For e.g. 'Fixes #(issue-number): PR name, fixing the particular bug' (without commas)
  • There should be always 1 commit for 1 PR
  • If there are more than 1 commit in a PR, squash them.
  • Pull Request details should be descriptive.
  • Commit message should meaningful.