From eab16db9308c7662e5afa6af06e622c1ebb4e0a3 Mon Sep 17 00:00:00 2001 From: Shawn Maddock Date: Wed, 9 Jul 2025 14:05:33 -0500 Subject: [PATCH 1/2] fixes #1663 --- CONTRIBUTING.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d25fa1f2d..62061dbe8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,7 @@ PHP_VERSION=8.3 make all ``` For repeatability and consistency across different operating systems, we use the [3 Musketeers pattern](https://3musketeers.pages.dev/). If you're on Windows, it might be a good idea to use Git bash for following the steps below. -**Note: After cloning the repository, copy `.env.dist` to `.env`.** +**Note: After cloning the repository, copy `.env.dist` to `.env`.** Skipping the step above would result in a "`The "PHP_USER" variable is not set. Defaulting to a blank string`" warning @@ -62,7 +62,7 @@ This does the following things: * Performs static analysis with [Phan](https://github.com/phan/phan), [Psalm](https://psalm.dev/) and [PHPStan](https://phpstan.org/user-guide/getting-started) -## Local Run/Build +## Local Run/Build To ensure you have all the correct packages installed locally in your dev environment, you can run @@ -92,7 +92,7 @@ make all-checks ``` ## Testing -To make sure the tests in this repo work as you expect, you can use the included docker test wrapper. +To make sure the tests in this repo work as you expect, you can use the included docker test wrapper. To run the test suite, execute ```bash @@ -106,8 +106,8 @@ that doesn't pass our currently defined tests will emit a failure in CI Even though it may not be reflected everywhere in the codebase yet, we aim to provide software which is easy to read and change. The methods described in Clean Code book(s) by Robert C. Martin (Uncle Bob) are a de facto industry standards nowadays. -Reading those books is highly recommended, however you can take a look at the examples given at [Clean Code PHP](https://github.com/jupeter/clean-code-php). -While we have no rule to strictly follow said methods and patterns, they are highly recommended as an orientation for +Reading those books is highly recommended, however you can take a look at the examples given at [Clean Code PHP](https://github.com/jupeter/clean-code-php). +While we have no rule to strictly follow said methods and patterns, they are highly recommended as an orientation for your pull requests and to be referenced in reviews. We might add additional guidelines regarding for example testing in the future. @@ -166,7 +166,7 @@ during CI and is a required check. Code that doesn't match the standards that we our [phan config](https://github.com/open-telemetry/opentelemetry-php/blob/master/.phan/config.php) will emit a failure in CI. -We also use [Psalm](https://psalm.dev/) as a second static analysis tool. +We also use [Psalm](https://psalm.dev/) as a second static analysis tool. You can use our psalm docker wrapper to easily perform static analysis on your changes. To run Psalm, one can run the following command: @@ -306,8 +306,8 @@ For more information about the emeritus role, see the [community repository](htt Most of our communication is done on CNCF Slack in the channel [otel-php](https://cloud-native.slack.com/archives/C01NFPCV44V). To sign up, create a CNCF Slack account [here](http://slack.cncf.io/) -Our meetings are held weekly on zoom on Wednesdays at 10:30am PST / 1:30pm EST. -A Google calendar invite with the included zoom link can be found [here](https://calendar.google.com/event?action=TEMPLATE&tmeid=N2VtZXZmYnVmbzZkYjZkbTYxdjZvYTdxN21fMjAyMDA5MTZUMTczMDAwWiBrYXJlbnlyeHVAbQ&tmsrc=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com&scp=ALL) +Our meetings are held weekly on Zoom on Wednesdays at [12:00 UTC](https://www.google.com/search?q=1200+utc+to+local). +A Google calendar invite with the included Zoom link can be found [here](https://calendar.google.com/event?action=TEMPLATE&tmeid=N2VtZXZmYnVmbzZkYjZkbTYxdjZvYTdxN21fMjAyMDA5MTZUMTczMDAwWiBrYXJlbnlyeHVAbQ&tmsrc=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com&scp=ALL), and a Google Doc with the meeting agenda/minutes can be found [here](https://docs.google.com/document/d/1WLDZGLY24rk5fRudjdQAcx_u81ZQWCF3zxiNT-sz7DI). Our open issues can all be found in the [GitHub issues tab](https://github.com/open-telemetry/opentelemetry-php/issues). Feel free to reach out on Slack if you have any additional questions about these issues; we are always happy to talk through implementation details. From 92ac6ebff68c6cf655f299d27303648a6b24044b Mon Sep 17 00:00:00 2001 From: Shawn Maddock Date: Wed, 9 Jul 2025 14:42:03 -0500 Subject: [PATCH 2/2] undo whitespace changes --- CONTRIBUTING.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 62061dbe8..c480b46ed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,7 @@ PHP_VERSION=8.3 make all ``` For repeatability and consistency across different operating systems, we use the [3 Musketeers pattern](https://3musketeers.pages.dev/). If you're on Windows, it might be a good idea to use Git bash for following the steps below. -**Note: After cloning the repository, copy `.env.dist` to `.env`.** +**Note: After cloning the repository, copy `.env.dist` to `.env`.** Skipping the step above would result in a "`The "PHP_USER" variable is not set. Defaulting to a blank string`" warning @@ -62,7 +62,7 @@ This does the following things: * Performs static analysis with [Phan](https://github.com/phan/phan), [Psalm](https://psalm.dev/) and [PHPStan](https://phpstan.org/user-guide/getting-started) -## Local Run/Build +## Local Run/Build To ensure you have all the correct packages installed locally in your dev environment, you can run @@ -92,7 +92,7 @@ make all-checks ``` ## Testing -To make sure the tests in this repo work as you expect, you can use the included docker test wrapper. +To make sure the tests in this repo work as you expect, you can use the included docker test wrapper. To run the test suite, execute ```bash @@ -106,8 +106,8 @@ that doesn't pass our currently defined tests will emit a failure in CI Even though it may not be reflected everywhere in the codebase yet, we aim to provide software which is easy to read and change. The methods described in Clean Code book(s) by Robert C. Martin (Uncle Bob) are a de facto industry standards nowadays. -Reading those books is highly recommended, however you can take a look at the examples given at [Clean Code PHP](https://github.com/jupeter/clean-code-php). -While we have no rule to strictly follow said methods and patterns, they are highly recommended as an orientation for +Reading those books is highly recommended, however you can take a look at the examples given at [Clean Code PHP](https://github.com/jupeter/clean-code-php). +While we have no rule to strictly follow said methods and patterns, they are highly recommended as an orientation for your pull requests and to be referenced in reviews. We might add additional guidelines regarding for example testing in the future. @@ -166,7 +166,7 @@ during CI and is a required check. Code that doesn't match the standards that we our [phan config](https://github.com/open-telemetry/opentelemetry-php/blob/master/.phan/config.php) will emit a failure in CI. -We also use [Psalm](https://psalm.dev/) as a second static analysis tool. +We also use [Psalm](https://psalm.dev/) as a second static analysis tool. You can use our psalm docker wrapper to easily perform static analysis on your changes. To run Psalm, one can run the following command: