Skip to content

Development Workflow

Here’s the quick overview of our development workflow:

Features, improvements, and bug fixes

Create your branch

1. Get the Branch Name

You can go to the issue you are working on in Linear and hit Cmd+Shift+. to copy the branch name.

Tack on something descriptive at the end like add_login.

2. Create the Branch

Jump into your terminal, go to your project, and run:

git checkout -b [issueId]/[description]

Do the Work

Work directly in your branch. Commit changes frequently with clear messages:

git add .
git commit -m "Add a concise commit message describing your change"
git push origin [issueId]/[description]

Open a Pull Request (PR)

Go to the repository on GitHub and create a pull request from your feature branch to the main branch. Ensure you describe your changes comprehensively in the pull request description.

Request a Review and Merge

Once your PR is approved you can merge with "squash and merge". The branch commits will be squashed into a single commit with the commit message of the last commit in the branch.

Note: Make sure that the squashed commit message contains the issue ID.

[OPTIONAL] Deploy preview environment

To deploy a preview environment, you add the deploy-preview label to the PR. This will deploy a preview environment with Preevy and the URLs will be available in the PR description.

Auth considerations

When deploying a preview environment the Authress tenant is shared with developers local environments as it uses the same Trially Development Authress tenant.

Important FE note: For the frontend to work in the preview environment you need to add the generated preview environment URL to the Trially Dev Authress application

Best Practices

Commit Guidelines

  • Commit small, logical changes.
  • Prefix with the issue ID.
  • Write meaningful commit messages.
  • Don't commit generated files or dependencies.

Pull Requests

All our pull requests need to be reviewed by at least one other person. Your PRs should be written in a way that makes it easy for the reviewer to understand the changes you made.

  • Ensure your PR is small and focused.
  • If your PR is a large change, consider breaking it down into smaller, more manageable PRs.

Handling Conflicts

  • When resolving conflicts you are unfamiliar with, communicate with team members to coordinate changes.