Skip to content

chore: prettify README.md #274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 25, 2025
Merged

chore: prettify README.md #274

merged 1 commit into from
Jul 25, 2025

Conversation

aduh95
Copy link
Contributor

@aduh95 aduh95 commented May 28, 2025

It makes sharing portion of the README much more readable:

Before:

Since access to the Mailgun API key is required, only members of the @nodejs/build-infra team have the permission to push code to the `main` branch. That was done in order to minimize the possibility of mismatches between the information in this repo, and the actual email routes that are set up.

After:

email/README.md

Lines 21 to 24 in 2fa47a6

Since access to the Mailgun API key is required, only members of the
@nodejs/build-infra team have the permission to push code to the `main` branch.
That was done in order to minimize the possibility of mismatches between the
information in this repo, and the actual email routes that are set up.

@aduh95
Copy link
Contributor Author

aduh95 commented Jul 25, 2025

@nodejs/build-infra can this be merged please?

@targos
Copy link
Member

targos commented Jul 25, 2025

I'm not sure what requirements are missing to merge. I would have to tick "Merge without waiting for requirements to be met (bypass rules)" to do it.

@UlisesGascon
Copy link
Member

UlisesGascon commented Jul 25, 2025

I'm not sure what requirements are missing to merge. I would have to tick "Merge without waiting for requirements to be met (bypass rules)" to do it.

+1 I'm seeing the same issue in #280 and plan to merge it, as it looks like a straightforward change. It also seems that we're bypassing the rules fairly often (ref).

I believe the original intention was to restrict merging to @nodejs/build-infra members, since changes need to be manually triggered. This also reminds me of the automation proposal in #222, though that would require a deeper discussion around handling production secrets in public GitHub Actions.

image

@UlisesGascon UlisesGascon self-assigned this Jul 25, 2025
@UlisesGascon UlisesGascon merged commit 0e74c55 into main Jul 25, 2025
@UlisesGascon UlisesGascon deleted the prettier-readme branch July 25, 2025 11:35
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.

4 participants