Skip to content

Latest commit

 

History

History
19 lines (12 loc) · 977 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (12 loc) · 977 Bytes
Raw

Contributing

Thank you for taking the time to consider contributing to CPCC!

We are mainly looking for contributions to utility parts of CPCC - they should be algorithm-related and should go in src/utils/. Of course, contributions to other parts of CPCC are still welcome!

Rules

  1. The file must end in a newline
  2. The name of the file must be the same as the name of the function implemented in it
  3. The name of the file must be all lowercase with no special characters

Guidelines

  1. Code inside of the files should not contain offensive language.
  2. Parts of the code where the user is welcome to modify should be commented as such: e.g. // subtract 1 if it is 1-indexed.
  3. Before writing your code, take a look at src/crucial/base/ to see the base code: you can use the macros provided there to make your code more readable.

Check out the todo for a list of things that need to be done.