valvin
/
ttrss
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update 'CONTRIBUTING.md'

This commit is contained in:
fox 2022-09-29 17:23:40 +03:00
parent 9437b45569
commit 3545d3ba83
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -5,6 +5,7 @@ TLDR: it works like Github.
1. Register on the [development website](https://dev.tt-rss.org); 1. Register on the [development website](https://dev.tt-rss.org);
2. Fork the repository you're interested in; 2. Fork the repository you're interested in;
3. Do the needful; 3. Do the needful;
4. Verify that your changes pass through PHPStan (see below);
4. File a PR against master branch; 4. File a PR against master branch;
If you have any other questions, see this [forum thread](https://discourse.tt-rss.org/t/how-to-contribute-code-via-pull-requests-on-git-tt-rss-org/1850). If you have any other questions, see this [forum thread](https://discourse.tt-rss.org/t/how-to-contribute-code-via-pull-requests-on-git-tt-rss-org/1850).
@ -12,6 +13,16 @@ If you have any other questions, see this [forum thread](https://discourse.tt-rs
Please don't inline patches in forum posts, attach files instead (``.patch`` or ``.diff`` file Please don't inline patches in forum posts, attach files instead (``.patch`` or ``.diff`` file
extensions should work). extensions should work).
## PHPStan
Here's an example on how to run the analyzer using Docker:
```sh
docker run --rm -v $(pwd):/app -v /tmp/phpstan-8.1:/tmp/phpstan --workdir /app php:8.1-cli php -d memory_limit=-1 ./vendor/bin/phpstan --memory-limit=2G --error-format=raw
```
Any errors break CI pipeline so you'll have to make sure it's clean.
## Contributing translations ## Contributing translations
Believe it or not, people also spam using Weblate. Therefore, some minor jumping through hoops is involved here: Believe it or not, people also spam using Weblate. Therefore, some minor jumping through hoops is involved here: