Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 2.22 KB
Raw

Contribution Guidelines

Steps to contribute

  • Check the code along with the issues and PR section if someone else has already worked on or is working on the algo and language you're interested in. If true, either implement it in a different language, or choose a different algo

  • Create (if not already created) an issue specifying the algorithm name and the language you want to implement it in. If the issue has been created by someone else, comment the language you will be working with for the concerned algo.

  • Fork the repo, write the required code, commit using descriptive messages, push to your fork

  • Make a PR with the title containing algorithm name and the language.

Naming Conventions:

It is preferred to use camel case in the naming of directories, files, variables, function names etc.

In case you have a modified version of the algorithm, you can use _ as a separator to create this distinction.
(For example, radixSort_withNegatives.cpp, palindrome_WithIterators.cpp, etc). Otherwise, stick to camel case.

Directory and file structure

For an algorithm say algoName, which is a type of a searching algorithm, the directory structure would be like:

\
 |- sortingAlgo
 |- searchingAlgo
     |- algoName
         |- algoName.c
         |- algoName.js
         |- algoName.py
     |- someOtherAlgo
     |- someOtherOtherAlgo
 |-someOtherTypeOfAlgo

Code

Format of code:

Write the main code in a function with the name of the function being the algorithm name, and having parameters as required. The return value should be the answer required to be printed.

For example, for a searching algorithm, we can have the function as someSearch(arr, x), and the return value as the index of x in arr.

Test Case:

It is preferred to have at least one testcase within the code instead of getting the input, and its output being printed by calling the function like print(funName(arr,x)) etc.

Stylistic guidelines:

  • Ensure that the code is properly indented
  • Preferably have some (not too many) comments to describe the logic