Workflow

Workflow

Who needs workflows?

We do, this is just to keep things organised and keep everyone on the same page

Tracker Workflow

For now, while actually building the code this can be skipped.

1. Ticket submitted to tracker
2. Ticket set as feature, bug, task or required improvement
3. Milestone set for which version it will appear in
4. If required blocker tag can be added which means it blocks the release.

Lets do some work then

1. In your own fork, you should create a branch based off the latest master branch in the main repo. This branch should be called ticket/TICKETID or feature/FEATURENAME or task/TASKNAME. For inital building call it inital-RANDOMNUMBER
2. You should then make a commit. Commits should be structured as detailed below.
3. Then push to your topic branch in your fork.
4. Then submit a pull request.
5. Then wait for a developer to merge it. If you are a developer, if its big get someone to review it, if its small merge it yourself (using the merge button).

Make a release

A release will be made when all three of the main developers (or two if one cannot be contacted) agree it is time for a release.

1. Update all version numbers, check through all files.
2. Generate a package
3. Create a test install
4. Fix any issues you may come across then repeat steps 3 and 4.
5. Create a final package using the build script
6. Generate a bbcode changelog using the build script
7. Generate a version check file using the build script
8. Tag release on github
9. Upload download to github
10. Create next release on the tracker as a milestone
11. Re-assign any remaining tickets to the next release
12. Update download link, version etc. in the development first post. (Can only be done by
13. Post a reply to development topic including change log and contributors.
14. Update version check.
15. Celebrate a release!

Commit Messages

They should be formatted like phpBB Commit messages, except the ticket number should be TICKET-#{ticketID}.