Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 2.25 KB
Raw

Contributing guidelines

Before contributing

Welcome to Algo-Phantoms/Algo-ScriptML. Before sending your pull requests, make sure that you read the whole guidelines. If you have any doubt on the contributing guide, please feel free to reach out to us.

Contribution

We appreciate any contribution, from fixing a grammar mistake in a comment to implementing complex algorithms. Please read this section if you are contributing your work.

Coding Style

We want your work to be readable by others; therefore, we encourage you to note the following:

  • Follow PEP8 guidelines. Read more about it here.

  • Please write in Python 3.7+. print() is a function in Python 3 so print "Hello" will not work but print("Hello") will.

  • Please focus hard on naming of functions, classes, and variables. Help your reader by using descriptive names that can help you to remove redundant comments.

    • Please follow the Python Naming Conventions so variable_names and function_names should be lower_case, CONSTANTS in UPPERCASE, ClassNames should be CamelCase, etc.
    • Expand acronyms because gcf() is hard to understand but greatest_common_factor() is not.

  • Avoid importing external libraries for basic algorithms. Only use those libraries for complicated algorithms. Usage of NumPY is highly recommended.

Other points to remember while submitting your work:

  • File extension for code should be .py.
  • Strictly use snake_case (underscore_separated) in your file_name, as it will be easy to parse in future using scripts.
  • Please avoid creating new directories if at all possible. Try to fit your work into the existing directory structure. If you want to. Please contact us before doing so.
  • If you have modified/added code work, make sure the code compiles before submitting.
  • If you have modified/added documentation work, ensure your language is concise and contains no grammar errors.
  • Do not update the README.md and Contributing_Guidelines.md.

Happy Coding :)