Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Protected-Branch README.md #2383

Merged
merged 3 commits into from
Aug 10, 2023
Merged

Update Protected-Branch README.md #2383

merged 3 commits into from
Aug 10, 2023

Conversation

aldrichdev
Copy link
Contributor

@aldrichdev aldrichdev commented Aug 4, 2023

What Changed

  • Grammar and formatting fixes
  • Reworded some segments or added info
  • Removed unnecessary "Configure it correctly" step that just pointed to the current section
  • In Usage section, added clarification of which file to add config to

Why

This readme was hard to read and poorly formatted.

Change Type

Indicate the type of change your pull request is:

  • documentation
  • patch
  • minor
  • major

Notes

I think we need to add info about the "Automatic release" PR that gets created after merging a PR. I do not understand it completely yet (it seems to only update the changelog and isn't automatically merged?), so I would not be the best person to document it (yet 馃槂).

- Grammar and formatting fixes
- Reworded some segments or added info
- Removed unnecessary "Configure it correctly" step that just pointed to the current section

I think we need to add info about the "Automatic release" PR that gets created after merging a PR. I do not understand it completely yet, so I would not be the best person to document it (yet 馃槂).
Minor formatting changes
Added clarification in Usage section as to which file we add the config to.
@hipstersmoothie hipstersmoothie added the documentation Changes only affect the documentation label Aug 10, 2023
@hipstersmoothie hipstersmoothie merged commit fc78a59 into intuit:main Aug 10, 2023
1 check passed
@hipstersmoothie
Copy link
Collaborator

Thanks!

@github-actions
Copy link

馃殌 PR was released in v11.0.1 馃殌

@github-actions github-actions bot added the released This issue/pull request has been released. label Aug 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants