File tree 1 file changed +35
-0
lines changed
1 file changed +35
-0
lines changed Original file line number Diff line number Diff line change
1
+ Thanks for considering contributing to this project! Pull requests are welcome,
2
+ and if you want to discuss something before starting (or just check if the maintainer is still alive),
3
+ feel free to open an issue first.
4
+
5
+ ## Code style
6
+
7
+ This project comes with a [ ruleset.xml] ( https://github.com/scriptotek/php-marc/blob/master/ruleset.xml ) file that
8
+ defines the code style (which is PSR-2 at the time of this writing), so it can be checked with
9
+ [ phpcs] ( https://github.com/squizlabs/PHP_CodeSniffer ) :
10
+
11
+ phpcs --standard=ruleset.xml src
12
+
13
+ The project also comes with an [ .overcommit.yml] ( https://github.com/scriptotek/php-marc/blob/master/.overcommit.yml )
14
+ file so you can use [ Overcommit] ( https://github.com/sds/overcommit ) 's Git hooks to have your changes checked before
15
+ each commit.
16
+
17
+ ## Tests
18
+
19
+ Tests are run using [ PhpUnit] ( https://phpunit.de/ ) :
20
+
21
+ ./vendor/bin/phpunit
22
+
23
+ If you add new functionality, please consider also adding a test case for it.
24
+
25
+ ## Changelog
26
+
27
+ Consider adding an entry to the [ CHANGELOG] ( https://github.com/scriptotek/php-marc/blob/master/CHANGELOG.md ) as part
28
+ of your commit.
29
+
30
+ ## Code of conduct
31
+
32
+ This project adheres to the [ Open Code of Conduct] [ code-of-conduct ] . By
33
+ participating, you are expected to honor this code.
34
+
35
+ [ code-of-conduct ] : https://github.com/civiccc/code-of-conduct
You can’t perform that action at this time.
0 commit comments