Pull Request Checklist

Owned by Marc Johnson
Jun 24, 2020
1 min read
  • Do the changes meet the intended purpose described in the feature or story?
  • Is it up to date with master, either via a merge into the branch or a rebase (can it be straight auto-merged)?
  • Do the tests pass?
  • Do the tests reflect the changes?
    • Do the tests reflect scenarios described in the story or feature?
    • Do the tests reflect common failure or validation scenarios?
  • Are there up to date examples in the JSON.schema?
  • Do the RAML and JSON.schema pass checks (e.g. RAMLCop)?
  • Is there sample data (particularly for (fixed) controlled vocabularies)?
  • Has the implementation version been updated (Did the behaviour change)?
    • In the maven pom.xml (or similar)
    • In the news
  • Has the interface version been updated (Did the client protocol change)?
    • In the module descriptor
    • In the news
    • In the interface definition
  • Does the module descriptor expose the right interfaces and dependencies?
  • Are the dependent interface versions provided by another module?
  • Are the correct module permissions expressed on each endpoint?
  • Are the correct permissions expressed on each endpoint?
  • Are all of the permissions defined?
  • Are all of the permissions in the “all” set?
  • Has the news been updated?
  • SonarQube metrics
  • Does the JIRA issue have the correct
    • project
    • fix version
  • Do the commit messages have issue reference?
  • Are there any snapshot dependencies (for backend modules)?