Contributing

Documentation

Dispatch documentation is managed via Gitbook.

Doing a release

Creating a release of Dispatch requires the step below.

Updating sample data

If the database schema changes, we will need to update the sample data accordingly.

• Run the Bash script update-example-data.sh in the data directory.
• Create a commit with any changes
• Create a pull request with the change
• Merge change

Bumping the version number

• Update the version number in dispatch/__about__.py
• Create a new entry in the changelog
• Create a commit with the changelog changes
• Create a pull request with the change
• Merge change

Change log

• Create a new changelog with all significant changes since the last release
• Update GitHub releases: https://github.com/Netflix/dispatch/releases
• Publish the release

Update 'latest' tag

We rely on the latest tag to identify the most current stable version. Follow the steps below to update this tag:

Delete the previous tag:

git tag -d latest

Create a new tag:

git tag -a latest <commit>

Push the tag:

git push origin latest