docs: update "Good practices" document - Githubissues

vuestorefront / vue-storefront

Alokai is a Frontend as a Service solution that simplifies composable commerce. It connects all the technologies needed to build and deploy fast & scalable ecommerce frontends. It guides merchants to deliver exceptional customer experiences quickly and easily.

https://www.alokai.com

MIT License

10.59k stars 2.08k forks source link

docs: update "Good practices" document #6708

Closed Sayanta66 closed 2 years ago

Sayanta66 commented 2 years ago

Copyedited the document with some additions, deletions and fixings

Description

There were agreement mistakes, grammatical mistakes, and some unwanted punctuations in the "good-practices.md" doc. I fixed those errors.

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots:

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[x] I have read the CONTRIBUTING document.

Changelog

[ ] I have updated the Changelog (V1) v2 and mentioned all breaking changes in the public API.
[ ] I have documented all new public APIs and made changes to existing docs mentioning the parts I've changed so they're up to date.

Tests

[ ] I have written test cases for my code
[ ] I have tested my Pull Request on production build and (to my knowledge) it works without any issues
[ ] I have added tests to cover my changes.
[ ] All new and existing tests passed.

I tested manually my code, and it works well with both:
[ ] Default Theme
[ ] Capybara Theme

Code standards

[ ] My code follows the code style of this project.
[ ] I have followed naming conventions

Docs

[x] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.

filipsobol commented 2 years ago

Thank you for your contribution, we appreciate it :)