Skip to content

Commit 5adca3f

Browse files
committed
Normalize repository files
1 parent 724c5d7 commit 5adca3f

3 files changed

Lines changed: 38 additions & 21 deletions

File tree

‎.gitattributes‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
* text=auto eol=lf
22

3-
/.git* export-ignore
4-
/.php-cs-fixer.dist.php export-ignore
5-
/phpstan.neon.dist export-ignore
6-
/phpunit.xml.dist export-ignore
7-
/docs/ export-ignore
8-
/tests/ export-ignore
3+
/.gitattributes export-ignore
4+
/.github export-ignore
5+
/.gitignore export-ignore
6+
/.php-cs-fixer.dist.php export-ignore
7+
/composer.lock export-ignore
8+
/docs export-ignore
9+
/phpstan.neon.dist export-ignore
10+
/phpunit.xml.dist export-ignore
11+
/tests export-ignore
912

10-
/tests/** linguist-vendored
11-
/docs/** linguist-documentation
13+
/docs/** linguist-documentation
14+
/tests/Fixtures/** -linguist-detectable
15+
/tests/fixtures/** -linguist-detectable

‎.gitignore‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
/.phpunit.cache/
2-
/var/
31
/vendor/
2+
/composer.lock
3+
/.phpunit.cache/
4+
/.phpunit.result.cache
45
/.php-cs-fixer.cache
6+
/coverage/
57
/coverage.xml
6-
/composer.lock
7-
/phpstan.neon
8-
/phpunit.xml

‎README.md‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -356,20 +356,34 @@ $file->headers['index']; // 'index abcdef..123456 100644'
356356
- [Errors](docs/errors.md): recover from rejected inputs and patches.
357357
- [Complete documentation](docs/index.md): review the package scope and every guide.
358358

359-
## Testing
359+
## Contributing
360360

361-
Run the test suite:
361+
Contributions of all kinds are welcome. Visit the
362+
[project on GitHub](https://github.com/altophp/code-diff) to
363+
[report a bug](https://github.com/altophp/code-diff/issues/new),
364+
[suggest a feature](https://github.com/altophp/code-diff/issues/new), or
365+
[open a pull request](https://github.com/altophp/code-diff/pulls).
366+
367+
Before submitting code, run:
362368

363369
```bash
364-
vendor/bin/phpunit
370+
# Runs PHP CS Fixer, PHPStan, and PHPUnit
371+
composer qa
365372
```
366373

367-
Run tests with coverage:
374+
Changes to public behavior should include tests and documentation.
368375

369-
```bash
370-
vendor/bin/phpunit --coverage-text
371-
```
376+
## Support
377+
378+
ALTO Code Diff is open source and independently maintained by
379+
[Simon André](https://smnandre.dev). If it is useful to your work, you can
380+
support its continued development through
381+
[GitHub Sponsors](https://github.com/sponsors/smnandre).
382+
383+
Sharing the package or
384+
[starring it on GitHub](https://github.com/altophp/code-diff) also helps.
372385

373386
## License
374387

375-
This project is licensed under the [MIT License](./LICENSE).
388+
ALTO Code Diff is released by [ALTO PHP](https://altophp.com) under the
389+
[MIT License](LICENSE).

0 commit comments

Comments
 (0)