development workflow
This is a guide to develop and make changes to Assimbly.
For more detailed information about how to set up Assimbly for development, see:
In order to automate some of the most time-consuming tasks, we created a workflow that runs GitHub actions in the background. For all those automations to work properly, we need to follow some steps as we develop Assimbly.
See the diagram below to have an overview of the development workflow:
Note: This workflow should be used for any changes that should be referred in the release notes.
-
Open a new issue:
-
Go to the repository you need change and on the Issues tab choose "New issue".
-
Add the Assignee and one of the following labels:
- feature / enhancement
- fix / bugfix / bug
- chore / wip
-
This will automatically create a branch for the issue as well as a matching draft PR based on the labels set.
-
-
Make changes:
- Checkout to the newly created branch locally:
- Make the changes you want on that issue branch, and when you’re happy with the results, commit and push it.
- Every commit will be pushed to the draft PR created by the automation.
- When all changes are done mark the PR as OK and request a review
-
Review:
- When approved the reviewer will merge the PR.
Use this same procedure to any changes you want to do.
- Create an issue called “Adding a new feature” with the “feature” label
- The workflow will then automatically create a branch called “feature/issue-x/adding-a-new-feature” based on the develop branch, as well as a matching PR from that branch to develop.
- Locally pull and checkout to that newly created branch and add your new feature there
- Commit and push the changes, which will show up in the PR created by the workflow
- After all changes are done and pushed, you can merge it and delete that branch
- After merging and deleting the branch, you can now close the issue
