simorgh icon indicating copy to clipboard operation
simorgh copied to clipboard

update docs with coding standards

Open jroebu14 opened this issue 1 year ago • 1 comments

Resolves NEWSWORLDSERVICE-1494

Overall change: Adds agreed set of component standards to the docs.

Replaces old coding standards doc.

TODO Still to provide some code examples for some of the standards.


  • [ ] I have assigned myself to this PR and the corresponding issues
  • [ ] I have added the cross-team label to this PR if it requires visibility across World Service teams
  • [ ] I have assigned this PR to the Simorgh project
  • [ ] (BBC contributors only) This PR follows the repository use guidelines

Testing:

  • [ ] Automated (jest and/or cypress) tests added (for new features) or updated (for existing features)
  • [ ] If necessary, I have run the local E2E non-smoke tests relevant to my changes (CYPRESS_APP_ENV=local CYPRESS_SMOKE=false yarn test:e2e:interactive)
  • [ ] This PR requires manual testing

jroebu14 avatar Jul 28 '22 13:07 jroebu14

It's surprisingly hard to come up with bad examples

Screen Shot 2022-08-03 at 17 18 57

RetiredBlob avatar Aug 03 '22 16:08 RetiredBlob