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

[doc]: Update (or remove) project coding standards wiki #3188

Open
2 tasks
sirugh opened this issue May 24, 2021 · 3 comments
Open
2 tasks

[doc]: Update (or remove) project coding standards wiki #3188

sirugh opened this issue May 24, 2021 · 3 comments
Labels
documentation This pertains to documentation. Progress: ready for grooming

Comments

@sirugh
Copy link
Contributor

sirugh commented May 24, 2021

Describe the request
The coding standards wiki was supposed to be a living document but hasn't been updated in some time, likely around when we started adding graphql. But as you can see, even the gql docs are dated as we now recommend passing an operations object instead of queries and `mutations.

We should remove outdated information, update existing, and add new where missing.

Possible solutions

  • Do it all in one go, or at least remove outdated/inaccurate information first.
  • Because the wiki is editable in browser on github, and not maintained in code, I recommend using a gist to propose updates and have the gist reviewed before applying changes.

Screenshots
If applicable, add screenshots to help explain the problem.

Please let us know whether this is a new topic or a topic change request:

  • New Topic Request (ie. missing entire topic/section)
  • Topic Change Request (ie. spelling, organization)
@sirugh sirugh added the documentation This pertains to documentation. label May 24, 2021
@m2-assistant
Copy link

m2-assistant bot commented May 24, 2021

Hi @sirugh. Thank you for your report.
To help us process this issue please make sure that you provided sufficient information.

Please, add a comment to assign the issue: @magento I am working on this


@sirugh
Copy link
Contributor Author

sirugh commented May 24, 2021

@magento export issue to JIRA project PWA as Task

@github-jira-sync-bot
Copy link

✅ Jira issue https://jira.corp.magento.com/browse/PWA-1786 is successfully created for this GitHub issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This pertains to documentation. Progress: ready for grooming
Projects
None yet
Development

No branches or pull requests

3 participants