Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

62 lines (41 loc) · 2.57 KB
Raw

Contributing

Issue

  1. Check that the issue has not already been reported (search here)

  2. Fill in the Issue Template

  3. Include any relevant logs

    • server logs from the logs folder
    • browser logs from the developer console ( chrome, firefox, edge)

  4. Ensure any error messages or code snippets are noted with a fenced code block

  5. Screenshots for UI errors are helpful

Pull Request

  1. Commit code and push to Github

  2. Open a Pull Request to development branch

  3. Fill out the information requested in the Pull Request Template

  4. Ensure that code passes tests

    • Test results are reported to PR status
    • Tests can be run locally using npm run lint and npm test
    • Some lint errors can automatically resolved by running npm run lint-fix
    • Disabling tests is not fixing them

  5. Get a code review

    • A reviewer can approve a PR by writing a comment starting with Approved, LGTM, or :shipit:
    • A review can reject a PR by writing a comment starting with Rejected

  6. Merge

    • Any team member can merge an approved pull request
    • Your code is now part of the project 😄

Code Review

  1. Ensure Pull Request is to correct branch
  2. Ensure Pull Request fills in the Pull Request Template
  3. Ensure code passes tests and lint checks pass (reported to PR status)
  4. Ensure functionality meets acceptance criteria for user story or issue
  5. Ensure new functionality has tests
  6. Ensure no tests or lint checks have been needlessly disabled
  7. Ensure new code makes sense and is readable

How-To