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

Update README.md #15

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README.md #15

wants to merge 2 commits into from

Conversation

caetano1
Copy link

@caetano1 caetano1 commented Nov 27, 2020

Update the readme to match the the vtex-apps template, and add the warning message that this is an unfinished app.

What problem is this solving?

How should this be manually tested?

N/A

Checklist/Reminders

  • Updated README.md.
  • Updated CHANGELOG.md.
  • Linked this PR to a Jira story (if applicable).
  • Updated/created tests (important for bug fixes).
  • Deleted the workspace after merging this PR (if applicable).

Screenshots or example usage

Type of changes

✔️ Type of Change
_ Bug fix
_ New feature
_ Breaking change
_ Technical improvements

Notes

Update the readme to match the the vtex-apps template, and add the warning message that this is an unfinished app.
@caetano1 caetano1 requested a review from a team as a code owner November 27, 2020 00:17
@vtex-io-ci-cd
Copy link

vtex-io-ci-cd bot commented Nov 27, 2020

Hi! I'm VTEX IO CI/CD Bot and I'll be helping you to publish your app! 🤖

Please select which version do you want to release:

  • Patch (backwards-compatible bug fixes)

  • Minor (backwards-compatible functionality)

  • Major (incompatible API changes)

And then you just need to merge your PR when you are ready! There is no need to create a release commit/tag.

  • No thanks, I would rather do it manually 😞

@vtex-io-docs-bot
Copy link

Beep boop 🤖

Thank you so much for keeping our documentation up-to-date ❤️

docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
@@ -68,3 +78,24 @@ Changes the selected delivery option to be the one which has the given `delivery
```tsx
selectDeliveryOption('PAC')
```

Choose a reason for hiding this comment

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

I believe this info should be divided into different sections: Configuration and Modus Operandi. The Configuration section should teach users how to set up the app in their VTEX accounts and/or their store themes. In turn, the Modus Operandi section should contain further info regarding the app behavior i.e. how users should properly use it.

Copy link
Author

Choose a reason for hiding this comment

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

The app is still under construction, and most probably it will become private.. It is really urgent to update the readme with the warning for now 🙏

docs/README.md Outdated Show resolved Hide resolved
Base automatically changed from master to main February 19, 2021 20:07
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.

2 participants