Skip to content

Commit e7a1f74

Browse files
authored
Update CONTRIBUTING.md
1 parent 8b50d1e commit e7a1f74

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

CONTRIBUTING.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
11
# Contributing to php-crud-api
22

3-
Pull requests are welcome. Please use "phpfmt" and run the build and the tests.
3+
Pull requests are welcome.
4+
5+
## Use phpfmt
6+
7+
Please use "phpfmt" to ensure consistent formatting.
8+
9+
## Run the tests
10+
11+
Before you do a PR, you should ensure any new functionality has test cases and that all existing tests are succeeding.
12+
13+
## Run the build
14+
15+
Since this project is a single file application, you must ensure that classes are loaded in the correct order.
16+
This is only important for the "extends" and "implements" relations. The build script appends the classes in
17+
alphabetical order (directories first). The path of the class that is extended or implemented must be alphabetically
18+
first. The build will fail with a "Class not found" error message if you get this wrong.

0 commit comments

Comments
 (0)