We're using Git and GitHub; here's the GitHub repository:

• https://github.com/BrookesUniversityLearningResources/vsat

The contribution process typically involves:

• pulling main to ensure you're up to date
• switching to a new branch where you'll make your changes
• committing those changes with one or more useful messages
• pushing your feature branch to GitHub
  • you may wish to rebase from main to ensure you're up to date
• creating a Pull Request (PR) to merge your feature branch into main
  • ensure that the tests pass
  • ensure that the linting / formatting is cool
• getting your PR reviewed by someone else on the team
  • proactively assign the PR to someone for review
  • you may need to action any review comments
  • you may find the BBC's guide to helpful code reviews worth reading
• rebasing / or squashing your branch into main once your PR is approved

We're using Biome for our formatter and linter.

The package.json has two scripts—format and lint—that you can run to format and lint the codebase.

Use whatever editor / IDE you like so long as any code:

• is formatted per our formatter
• is linted per our linter

If you're using VSCode then install the official Biome extension.

If you're using another editor / IDE then it's on you to ensure conformance with our formatting / linting standards.