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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjust wording and add image #13

Merged
merged 17 commits into from
Sep 16, 2021
Merged

Adjust wording and add image #13

merged 17 commits into from
Sep 16, 2021

Conversation

rytswd
Copy link
Contributor

@rytswd rytswd commented Aug 25, 2021

WHAT

Better wording and clarify why this is useful

WHY

For better onboarding and introduction

@rytswd rytswd requested a review from hlts2 August 25, 2021 22:15
@rytswd rytswd requested a review from teruhiky August 26, 2021 12:40
hlts2
hlts2 previously approved these changes Aug 27, 2021
Copy link

@teruhiky teruhiky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some typos and suggestions, the changes are mostly good and this is significantly easier to understand though

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/action-usage.md Show resolved Hide resolved
docs/details.md Outdated Show resolved Hide resolved
@rytswd rytswd requested a review from teruhiky September 3, 2021 22:12
Copy link

@teruhiky teruhiky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo is fixed, and clearer description by extra sentences.
LGTM

just 1 point is left to be discussed
adding a comment below to clarify where to update.

on:
  pull_request:
    branches: # please update accordingly
      - main
      - master

this is just IMO and not so important.

@rytswd rytswd merged commit 67f3c3a into main Sep 16, 2021
@rytswd rytswd deleted the add-more-documentation branch September 16, 2021 16:20
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.

3 participants