Skip to content

4 Dev Resources

ShannonTucker edited this page Feb 2, 2022 · 1 revision

Welcome to the DECD-Design-System wiki!

Design System Inventory

Testing Documentation

Useful Links

React testing overview

React Testing Library documentation

Jest documentation

Accessibility Documentation

Useful Links

ESDC / IT Accessibility Office Resources

Insight on developing accessible libraries

Axe overview

Comparison between Axes an other web browser tools

Screen Reader Tools for testing different browsers

Helpful Commands for Screen Reader Testing

Code Review Helpful Tips

Based on "How to Do Code Reviews Like a Human" by Michael Lynch

  1. Give code examples - leave a code snippet as a comment or create a branch off of their feature branch
  2. Avoid "you" - critique the code not the person, use language like "we", "should be", "could be", "how about"
  3. Avoid commands - use language that frames feedback as a request and starts a conversation or discussion like "can we?", "could this be?", there's no one right way to write code
  4. Give context - provide background or supporting knowledge when possible
  5. Give praise - recognize good work
  6. Limit feedback on repeated patterns - if the same error occurs more then once, point it out in one or two spots and ask the author to fix the pattern
  7. Respect the scope - if the changelist doesn't touch the line, it's out of scope unless the changelist affects surrounding code

Submitting Bugs on DECD Github

Current DECD system is following these are steps to report a bug.

  1. Login to DECD SYSTEM
  2. Click on Issues tab --> New issue -->Bug Repot and Get Started --> Submit

## > Template of Bug Report

`--- name: Bug report about: Create a report to help us improve title: '' labels: 'bug' assignees: ''


Describe the bug A clear and concise description of what the bug is.

To Reproduce Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Expected behavior A clear and concise description of what you expected to happen.

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

Desktop (please complete the following information):

  • OS: [e.g. iOS]
  • Browser [e.g. chrome, safari]
  • Version [e.g. 22]

Smartphone (please complete the following information):

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. stock browser, safari]
  • Version [e.g. 22]

Additional context Add any other context about the problem here.`

DECD Design System Discussions

  1. Go to Discussions tab on Github Repo
  2. Click Start New Discussion
Clone this wiki locally