mirror_php/TheAlgorithms-PHP
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/PHP.git synced 2025-07-10 03:26:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

updating contribution guide to include requirement for unit tests to be passing and code is linted with phpcs

Browse Source
This commit is contained in:
Brandon Johnson
2024-10-07 00:08:36 -06:00
parent 0cb4a4b5f2
commit 81fd012ab5
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -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`