From db336229cc966a47748060a058b91aee0beb612e Mon Sep 17 00:00:00 2001 From: svrnm Date: Thu, 7 Nov 2024 12:37:03 +0100 Subject: [PATCH 1/4] update pull request template Signed-off-by: svrnm --- .github/PULL_REQUEST_TEMPLATE.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000000..3aa49a2eb5c2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ + \ No newline at end of file From 1049e4a02c23cae7ef74d569d5c23e6310380b98 Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Thu, 7 Nov 2024 20:00:02 +0100 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com> --- .github/PULL_REQUEST_TEMPLATE.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3aa49a2eb5c2..45b232da1a50 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,14 +1,14 @@ \ No newline at end of file From 7e666ca7909c114cd52409b7a92b64256b4d882b Mon Sep 17 00:00:00 2001 From: svrnm Date: Mon, 11 Nov 2024 12:12:32 +0100 Subject: [PATCH 3/4] Chaning wording Signed-off-by: svrnm --- .github/PULL_REQUEST_TEMPLATE.md | 13 ++++++++++--- .github/PULL_REQUEST_TEMPLATE/DOCS_UPDATE.md | 6 ------ 2 files changed, 10 insertions(+), 9 deletions(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE/DOCS_UPDATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 45b232da1a50..fc030353972e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -6,9 +6,16 @@ the time needed to review. Please make sure to follow the [contribution guidelines](https://opentelemetry.io/docs/contributing/). -We run checks on all PRs. If a check fails on your PR, look for the fix in our [guide](https://opentelemetry.io/docs/contributing/pr-checks/). -Most issues can be resolved by running `npm run fix:all` locally and pushing the changes. -But please note that it is not your responsibility to fix these issues. We will help you. +We run checks on all PRs, to ensure that your contribution follows our [style guide](https://opentelemetry.io/docs/contributing/style-guide/). + +Many requirements of that guide can be enforced by running `npm run fix:all` locally and committing the changes. + +Note, that although those checks need to be green before we can merge your PR, do not +worry about their status after submitting your PR. We will provide you with guidance, when and how to +address them. + +Similarly, do not worry about your PR being out-of-date with the base branch and do not continuously +update or rebase your branch. We will let you know when it is necessary. If you have any questions, feel free to ask. --> \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/DOCS_UPDATE.md b/.github/PULL_REQUEST_TEMPLATE/DOCS_UPDATE.md deleted file mode 100644 index 0fe4d48c2fb8..000000000000 --- a/.github/PULL_REQUEST_TEMPLATE/DOCS_UPDATE.md +++ /dev/null @@ -1,6 +0,0 @@ -## Docs PR Checklist - - - -- [ ] This PR is for a documentation page whose authoritative copy is in the - opentelemetry.io repository. From 5a55638885bd22d63ce0b0d30f81ea8ab37c3454 Mon Sep 17 00:00:00 2001 From: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com> Date: Mon, 11 Nov 2024 20:20:35 +0000 Subject: [PATCH 4/4] Results from /fix:format --- .github/PULL_REQUEST_TEMPLATE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fc030353972e..63c825bee4f9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -12,10 +12,10 @@ Many requirements of that guide can be enforced by running `npm run fix:all` loc Note, that although those checks need to be green before we can merge your PR, do not worry about their status after submitting your PR. We will provide you with guidance, when and how to -address them. +address them. -Similarly, do not worry about your PR being out-of-date with the base branch and do not continuously +Similarly, do not worry about your PR being out-of-date with the base branch and do not continuously update or rebase your branch. We will let you know when it is necessary. If you have any questions, feel free to ask. ---> \ No newline at end of file +-->