Usual Workflow

Every feature, bug, improvement, and hotfix will be developed on a specific feature branch with an associated Pull Request(PR). Usually each issue will have only 1 PR, but may have more.

Branch naming convention is a short (usually 3-5 words) description in snake case.

Working on a previously defined issue

To work on an issue that has already been defined, you will only need the issue number.

In the terminal, run: startFromIssue <branch_name> <issue_number> <(OPTIONAL) PR_title> <(OPTIONAL) PR_description>

A title for the PR is only needed when it will be different from the title of the issue, by default the PR will have the same title as the issue.

The title, description, and other characteristics of the PR can be edited freely in Gitea after creation.

Developing something that does not have a defined issue

If an issue has not been created for the functionality that you will develop, use the startWork bash alias and it will create the issue.

In the terminal, run: startWork <branch_name> <title> <(OPTIONAL) description>

This will automatically create an issue and a PR with the same title and description, linking them to each other.

The title, description, and other characteristics of the issue and PR can be edited freely in Gitea after creation.