From 536085c764269af72f9e4e62ca04eed6dc853886 Mon Sep 17 00:00:00 2001 From: Andrew Dolgov Date: Tue, 5 Mar 2024 18:53:06 +0000 Subject: Update CONTRIBUTING.md --- CONTRIBUTING.md | 27 ++------------------------- 1 file changed, 2 insertions(+), 25 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eaad02c99..b0c6e81cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,31 +8,8 @@ Due to spam, new Gitlab users are set to [external](https://docs.gitlab.com/ee/u 2. Post on the forums asking for your account to be promoted; 3. Fork the repository you're interested in; 4. Do the needful; -5. Verify that your changes pass through PHPStan (see below); -6. File a PR against master branch; +6. File a PR against master branch and verify that CI pipeline (especially, PHPStan) passes; 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). -Please don't inline patches in forum posts, attach files instead (``.patch`` or ``.diff`` file -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 - -Believe it or not, people also spam using Weblate. Therefore, some minor jumping through hoops is involved here: - -1. Register on [Weblate](https://weblate.tt-rss.org/) / forums; -2. Post in the [Weblate discussion thread](https://community.tt-rss.org/t/easier-translations-with-weblate/1680) on the forum, ask to be added to a project -you're interested in; -3. You'll be given proper access rights and will be able to edit translations. - -That's it. If the language you're interested is not available yet, ask and we'll add it; +Please don't inline patches in forum posts, attach files instead (``.patch`` or ``.diff`` file extensions should work). -- cgit v1.2.3