Skip to content

Commit

Permalink
Update CONTRIBUTING
Browse files Browse the repository at this point in the history
- Validate the text with vale and fix some mistakes.

- Add tekst about copyrights and not using AI.
Original text about AI and Copyright is from Juliette, see: https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/.github/CONTRIBUTING.md#final-words

Permission is received, see: https://phpc.social/deck/@jrf_nl/113240279001777268
  • Loading branch information
tvbeek committed Oct 3, 2024
1 parent 9e87481 commit 5f5d452
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ vale:
entrypoint: [""]
stage: check
script:
- /bin/vale --config=tools/vale/.vale.ini docs README.md
- /bin/vale --config=tools/vale/.vale.ini docs README.md CONTRIBUTING.md
needs: []
dependencies: []

Expand Down
36 changes: 29 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,39 @@
# Contributing
Contributions are allways very welcome. This file is a guideline about how to contribute.

Contributions are always welcome. This file is a guideline about how to contribute.

## How to contribute
All the contributes need to be done with a merge request. It is possible to create a merge request prefixed with WIP: to ask for feedback or if you didn't know how to match all requirements.

All the contributions need to be done with a merge request. It is possible to create a merge request prefixed with WIP: to ask for feedback or if you didn't know how to match all requirements.
Please be sure to check all the [requirements](#requirements) before sending your merge request (except a WIP merge request)


## Do Not Violate Copyright

Only submit a PR with your own original code. Do NOT submit a PR containing code which you have largely copied from
an externally projects, unless you wrote said the code yourself.
Open source does not mean that copyright does not apply.
Copyright infringements will not be tolerated and can lead to you being banned from the repository.

## Do Not Submit AI Generated PRs

The same goes for (largely) AI-generated PRs. These are not welcome as they will be based on copyrighted code from others
without accreditation and without taking the license of the original code into account, let alone getting permission
for the use of the code or for re-licensing.

Aside from that, the experience is that AI-generated PRs will be incorrect 100% of the time and cost reviewers too much time.
Submitting a (largely) AI-generated PR will lead to you being banned from the repository.


## Requirements
* All the code need to confirm to the [PSR-12](https://www.php-fig.org/psr/psr-12/). You can check this localy with `vendor/bin/phpcs`
* We use [PHPMD](https://phpmd.org) to validate the quality of the code. You can check it localy with `vendor/bin/phpmd src text phpmd.xml.dist`
* Add tests for code changes, we use [PHPUnit](https://phpunit.de/). You can run the test with `vendor/bin/phpunit` this wil also generate some reports in the build directory.

* All the code need to confirm to the [PSR-12](https://www.php-fig.org/psr/psr-12/). You can check this local with `vendor/bin/phpcs`
* We use [PHPMD](https://phpmd.org) to validate the quality of the code. You can check it local with `vendor/bin/phpmd src text phpmd.xml.dist`
* Add tests for code changes, we use [PHPUnit](https://phpunit.de/). You can run the test with `vendor/bin/phpunit` this will also generate some reports in the build directory.
* We also use [PHPStan](https://phpstan.org/) to find possible bugs in the code. You can run it with `vendor/bin/phpstan`.
* Document the changes, any functional change or bug fix need to be writen in [CHANGELOG.md](CHANGELOG.md). Depending on your change you need to add some documentation to the [README.md](README.md)
* Respect [SemVer](http://semver.org/), we use Semanting Versioning so please respect it with the changes you want to add.
* Document the changes, any functional change or bug fix need to be written in [CHANGELOG.md](CHANGELOG.md). Depending on your change you need to add some documentation to the [README.md](README.md)
* Respect [SemVer](http://semver.org/), we use Semantic Versioning so please respect it with the changes you want to add.
* A merge request for a change. Please don't mix multiple changes in one merge request.
* Ask questions, if you are not sure about something ask it.
* Only submit the code that you wrote yourself.

3 changes: 2 additions & 1 deletion tools/vale/ignore-spelling/tech-words.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
config
laravel
phpstan
config
PHPUnit
shell_exec

0 comments on commit 5f5d452

Please sign in to comment.