Skip to content

RepoContributing.md

Latest commit

 

History

History
28 lines (16 loc) · 1.34 KB

RepoContributing.md

File metadata and controls

28 lines (16 loc) · 1.34 KB

Contributing to the Tempus Repository

Please follow the steps below to ensure that your contributions are inline with our naming conventions and QA practices before you push to the tempus repository.

1. Project naming conventions

Client Modules

  • Modules within libs/client/onboarding-clientshould be prefixed with OnboardingClient like so: OnboardingClientFeatureSignInModule
  • Modules within libs/client/shared should be prefixed with ClientShared like so: ClientSharedUiComponentsPresentationalModule
  • Ensure these file names are as brief as possible and reflected in library files as well as angular.json. To learn more about contributing to the frontend, see Frontend Contributing.

General

  • Directory names are in kebab-case
  • File names are in camelCase

2. Git conventions

Ensure your issue, branch, commits and PR names follow the patterns detailed in our wiki.

3. Linting

Run a lint check on the affected files as described in the Lint doc and resolve any errors.

4. PR structure

The PR description uses our template. Upon creation, ensure that the the contents are populated with details relevant to the issue and that the checklist is crossed off where appropriate.