Skip to content
This repository has been archived by the owner on Dec 29, 2023. It is now read-only.

Latest commit

 

History

History
21 lines (17 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

21 lines (17 loc) · 1.2 KB

How to contribute

  • Fork this repository
  • Clone your fork
  • Add this repository as second remote to your own with this command:
    git remote add upstream https://github.com/lucassouzavieira/DataStructures.git
  • Check our open issues or open a new if you find a trouble
  • Open a Pull Request to integrate your contribution

and also, we recommend reading the following article: Contributing to open source

Coding requirements and conventions

  • Variables and function names:
    • Always use lowercase and with an underscore as a word separator
  • For a given data structure (eg. linked lists), append the name of structure at end of name function. If the data structure has an very common abbreviation, you can use the abbreviation:
    • create_linked_list to linked list
    • create_bst to binary search trees
  • Use always C code. Check if your code attends the C11 standard.
  • If possible, adds the copyright information at the top of the new files.
  • Unitary tests are welcome. Please, add the unit tests for your implementations. This repository uses acutest for unitary tests.