Skip to content

updating contribution guide to include requirement for unit tests and linting #170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 7, 2024
Merged

updating contribution guide to include requirement for unit tests and linting #170

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
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
Loading