How to Make Updates to the General Code Base

As Support Engineers, we will sometimes make changes to repositories in the AssemblyAI GitHub repo. Most of the changes we make will involve updating the official documentation but we will occasionally help out Engineering by making straightforward changes in our general code base.

The guide below will be a step-by-step walkthrough of how to make updates to the general codebase.

1. Before starting, we encourage all developers to familiarize themselves with our wiki for guidance on Best Practices and Guidelines. This is from the Web monorepo but can be applied for changes for other repos in AssemblyAI.

2. Navigate to the AssemblyAI GitHub and find the repository you need to make changes in.

3. Clone the repository to your local machine.

4. Navigate into the directory for the repo you just cloned.

5. Switch to the staging branch.

6. Create a new branch off of the staging branch for your changes. Please refer to our Naming Conventions Guidelines for naming branches, commits, and pull requests.

7. Make the necessary code changes.

8. Make a commit for those changes. We follow the Conventional Commit message style for naming pull requests. Again, refer to our Naming Conventions Guidelines for naming branches, commits, and pull requests.

9. Push changes to the branch you created with git push origin <branch name>.

10. Navigate to the GitHub repository you updated and create a new Pull Request.