We loosely (but not religiously) follow the bbatsov/ruby-style-guide.
We use an automatic way of generating CHANGELOG.md using the github-changelog-generator gem. To regenerate the change log:
- Generate a personal access token on GitHub. You'll need this because the changelog generator makes so many requests to the GitHub API.
gem install github_changelog_generatorgithub_changelog_generator --token XXXXXXXXwhere XXXXXXXX is the GitHub personal access token.
The change log can be updated with each pull request to master. But it's only actually important to do it with production releases, each of which gets a new version number and git tag.
We keep track of version numbers in two places:
- Committed to code in
config/initializers/version.rb. - Tags on the git repository, listed at https://github.com/transitland/transitland-datastore/tags