Skip to content

Commit

Permalink
updating contribution guide to include requirement for unit tests to …
Browse files Browse the repository at this point in the history
…be passing and code is linted with phpcs
  • Loading branch information
darwinz committed Oct 7, 2024
1 parent 0cb4a4b commit 81fd012
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,12 @@ We want your work to be readable by others; therefore, we encourage you to note

If you used a Wikipedia article or some other source material to create your algorithm, please add the URL in a docstring or comment to help your reader

- Write tests
- Write proper unit tests (see examples in [tests](https://github.com/TheAlgorithms/PHP/tree/master/tests) and ensure all unit tests are passing (composer run-script test)

- Avoid importing external libraries for basic algorithms. Only use them for complicated algorithms

- Ensure code is linted with phpcs, and passing all linting checks (vendor/bin/phpcs -n)

#### Other Standard While Submitting Your Work

- File extension for code should be `.php`
Expand Down

0 comments on commit 81fd012

Please sign in to comment.