Skip to content

Commit

Permalink
fixup! feat: Update the community PR message to have collapsible sect…
Browse files Browse the repository at this point in the history
…ions
  • Loading branch information
xitij2000 committed Jan 7, 2025
1 parent 2a0a4e4 commit 2fa4bf8
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions openedx_webhooks/templates/github_community_pr_comment.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This repository has no maintainer (yet).
{% else %}
This repository is currently unmaintained.
{% endif %}
<details><summary>#### :radio_button: Find a technical reviewer</summary>
<details><summary><h4>:radio_button: Find a technical reviewer</h4></summary>
To get help with finding a technical reviewer, tag the community contributions project manager for this PR in a comment and let them know that your changes are ready for review:

1. On the right-hand side of the PR, find the Contributions project, click the caret in the top right corner to expand it, and check the "Primary PM" field for the name of your PM.
Expand All @@ -18,15 +18,15 @@ To get help with finding a technical reviewer, tag the community contributions p

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

<details><summary>#### :radio_button: Get product approval</summary>
<details><summary><h4>:radio_button: Get product approval</h4></summary>

If you haven't already, [check this list](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3875962884/How+to+submit+an+open+source+contribution+for+Product+Review#Does-my-contribution-require-Product-Review%3F) to see if your contribution needs to go through the product review process.

- If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the [Product Working Group](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3449028609/Product+Working+Group).
- This process (including the steps you'll need to take) is documented [here](https://openedx.atlassian.net/wiki/spaces/COMM/pages/3875962884/How+to+submit+an+open+source+contribution+for+Product+Review#Product-Review-Process).
- If it doesn't, simply proceed with the next step.
</details><details>
<summary>#### :radio_button: Provide context</summary>
<summary><h4>:radio_button: Provide context</h4></summary>

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Expand All @@ -42,7 +42,7 @@ To help your reviewers and other members of the community understand the purpose
- Relevant [Open edX discussion forum](https://discuss.openedx.org/) threads
</details><details>
{% if not has_signed_agreement %}
<summary>#### :radio_button: Submit a signed contributor agreement (CLA)</summary>
<summary><h4>:radio_button: Submit a signed contributor agreement (CLA)</h4></summary>

:warning: We ask all contributors to the Open edX project to submit a [signed contributor agreement](https://openedx.org/cla) or indicate their institutional affiliation.
Please see the [CONTRIBUTING](https://github.com/openedx/.github/blob/master/CONTRIBUTING.md) file for more information.
Expand All @@ -58,7 +58,7 @@ If the CLA check continues to fail, you can tag the `@openedx/cla-problems` team
{% endif %}

{% if is_first_time %}
<summary>#### :radio_button: Wait for tests to be enabled</summary>
<summary><h4>:radio_button: Wait for tests to be enabled</h4></summary>

It looks like you are contributing to this repository for the first time.
This means that automated tests won't run automatically, and that you'll need to wait for a test run to be authorized.
Expand All @@ -67,12 +67,12 @@ If you're experiencing a delay of two weeks or more at this step, tag the [commu
</details><details>
{% endif %}

<summary>#### :radio_button: Get a green build</summary>
<summary><h4>:radio_button: Get a green build</h4></summary>

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.
</details><details>
{% if is_draft %}
<summary>#### :radio_button: Update the status of your PR</summary>
<summary><h4>:radio_button: Update the status of your PR</h4></summary>

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.
</details><details>
Expand Down

0 comments on commit 2fa4bf8

Please sign in to comment.