close
The Wayback Machine - https://web.archive.org/web/20201015183640/https://github.com/grpc-ecosystem/grpc-gateway/issues/1575
Skip to content

/ grpc-gateway

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

Jump to bottom

Addition of Prettier GitHub action to prettified the markdown and docs files whenever there is PR #1575

Open
iamrajiv opened this issue Aug 9, 2020 · 2 comments
Open

Addition of Prettier GitHub action to prettified the markdown and docs files whenever there is PR #1575

iamrajiv opened this issue Aug 9, 2020 · 2 comments
Labels
documentation enhancement good first issue help wanted

Comments

@iamrajiv
Copy link
Contributor

@iamrajiv iamrajiv commented Aug 9, 2020

🚀 Feature

Addition of Prettier GitHub action to auto-format the markdown and docs files whenever there is PR.

What is Prettier?

  • An opinionated code formatter
  • Supports many languages
  • Integrates with most editors
  • Has few options

Prettier
@johanbrandhorst
Copy link
Collaborator

@johanbrandhorst johanbrandhorst commented Aug 10, 2020

Sounds like a good idea. Some things to consider:

  • It needs to be easy to apply by users if they've made docs changes, even if they're not used to using it. At the least something like a docker run oneliner we can add to CONTRIBUTING.md or of equivalent ease.
  • It needs to be run in CI as well to ensure it's applied consistently. Perhaps a new CI job with a similar docker one-liner.
@stale
Copy link

@stale stale bot commented Oct 9, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
@stale stale bot added the wontfix label Oct 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation enhancement good first issue help wanted
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
@johanbrandhorst @iamrajiv
You can’t perform that action at this time.