Gulfstream - Definition of Done

Owned by Oleksii Popov
Last updated: Apr 22, 2020 by Anastasiia Zakharova
2 min read


"A Definition of Done drives the quality of work and is used to assess when a User Story has been completed." 


Checklist:

  • The task is implemented according to the requirements with full scope.
  • Unit tests (BigTest for FE) are written and are passing.
    At least 80% code coverage is expected and 100% is preferred for critical code.
  • Data migration scripts are implemented for schema changes (in case of schema changes).
  • Localization is added for the English language (en.json). 
  • Pull request is created following the best project practices.
    Ideally, it should have a tasks link, description of changes and any useful info(e.g. additional links, screenshot).
    Example of a pull request: https://github.com/folio-org/ui-oai-pmh/pull/9
  • Peer code review is performed and at least one developer or TL from the team.
    It's suggested to add people from other teams, EBSCO and community.
    Critical pull requests should be reviewed by the main technical stakeholders, leads, architects.
  • Fix reported code smells, security vulnerabilities, lint errors that are reported by Sonarqube and other tools in the CI pipeline before merging code to master.
  • Existing API tests (BE modules) and Integration tests (BE modules) are maintained/implemented/improved and pass.
  • Any configuration and/or build scripts are updated and tested.
  • Build deployed successfully to snapshot environment.

  • QA is performed and issues resolved. The feature is tested against acceptance criteria.

  • Feature OK’ed by UX and complies with: (for FE only)
    - https://ux.folio.org/docs/guidelines/
    - WCAG 2.0 Level AA accessibility compliance (https://ux.folio.org/docs/assets/axe/) Since FOLIO uses rgb(a) ignore the color contrast errors that Deque aXe may report, instead can be used the WCAG color contrast tool https://chrome.google.com/webstore/detail/wcag-contrast-checker/plnahcmalebffmaghcpcmpaciebdhgdf to identify any errors.

  • The feature is accepted by PO (exception: spikes created by Solution Architect are mainly reviewed by him).
    PO reviews and move it to Done if acceptable.