Skip to content

Polish contributing guide wording#1776

Merged
alganet merged 1 commit into
Respect:3.1from
GabrielDenardi:docs-polish-contributing-guide
Jun 8, 2026
Merged

Polish contributing guide wording#1776
alganet merged 1 commit into
Respect:3.1from
GabrielDenardi:docs-polish-contributing-guide

Conversation

@GabrielDenardi

@GabrielDenardi GabrielDenardi commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

What changed

  • I corrected the contributing guide to say a common validator is composed of two files, matching the list that follows.
  • I smoothed a few wording issues in the validator testing, documentation, and checks sections.

Why

I wanted to make the guide clearer for new contributors following the validator creation workflow.

Validation

I ran the project QA checks in a Linux Docker container using PHP 8.5.6, with the required gettext and bcmath extensions installed:

  • php bin/console lint:spdx
  • php vendor/bin/phpcs
  • php vendor/bin/phpstan analyze --memory-limit=1G
  • php vendor/bin/phpunit --testsuite=unit
  • php vendor/bin/pest --testsuite=feature --compact
  • php bin/console lint:docs
  • php bin/console smoke-tests:check-complete

@codecov

codecov Bot commented Jun 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.41%. Comparing base (7d833fb) to head (8fd78ba).
⚠️ Report is 9 commits behind head on 3.1.

Additional details and impacted files
@@            Coverage Diff            @@
##                3.1    #1776   +/-   ##
=========================================
  Coverage     99.41%   99.41%           
  Complexity     1020     1020           
=========================================
  Files           194      194           
  Lines          2387     2387           
=========================================
  Hits           2373     2373           
  Misses           14       14           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@alganet alganet marked this pull request as ready for review June 8, 2026 19:21
@alganet alganet merged commit 2eb2807 into Respect:3.1 Jun 8, 2026
7 checks passed
@alganet

alganet commented Jun 8, 2026

Copy link
Copy Markdown
Member

Thanks for your contribution 🐼

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants