Contributions are welcome, and are greatly appreciated! Every little bit helps, and credit will be given. While at its core Tabbycat is a software project, you do not need to know how to code or use Git in order to help. We welcome feedback and ideas based on your tabbing experience and appreciate suggestions or proposals for how to improve the wording, translation, and design of our interface and documentation.
Feel free to join our Facebook group if you have any questions about how to get started.
Feedback and ideas¶
Please report bugs by opening a new issue in our GitHub repository. It is most helpful if you can include:
- How Tabbycat was installed (on Heroku, locally on macOS, etc.)
- Any details about your tournament and setup that might be helpful in troubleshooting
- Detailed steps for how to reproduce the bug
Getting started with development¶
To easily test your changes to Tabbycat you probably want a working local install (without using Docker)
Generally we prefer that features and bug fixes are submitted as pull requests on their own branch (as described in the git-flow workflow). Submitting against develop (but not master) is fine for small fixes and changes.
We use Django’s testing tools — it would be great if new features came with unit tests
By default the development server’s build process will broadcast livereload events; installing one of their browser plugins can make testing front-end changes easier.
A number of extra dependencies are required for running tests, linting, and serving the documentation. These can be installed with:
$ pip install -r 'requirements_development.txt'
For python code, we use flake8 to check for a non-strict series of style rules. Warnings will trigger a Travis CI build to fail. The entire codebase can be checked by using:
$ flake8 .
$ npm run stylelint
$ npm run eslint
For the front end interface design there is a style guide available at “/style/” once a tournament has been setup.
Our convention is to increment the minor version whenever we add new functionality, and to increment the major version whenever:
- the database can’t be migrated forwards using
python manage.py migrate --no-input, or
- there is a major change to how the tournament workflow goes, or
- we make some other change that is, in our opinion, significant enough to warrant a milestone.
Most of the time, we write data migrations to allow existing systems to be upgraded easily. However, we don’t always support backward database migrations. Our expectation is that long-lived installations keep up with our latest version.
One day, we hope to have a public API in place to facilitate the integration with other debating tournament software, like registration or adjudicator feedback systems. If and when that happens, we’ll probably revise this convention to be more in line with Semantic Versioning.
Starting from version 0.7.0, we use cat breeds as the code names for major versions.
To preview the documentation locally, install the development dependencies and then start the server:
$ sphinx-autobuild docs docs/_build/html --port 7999
You should then be able to preview the docs at 127.0.0.1:7999.
bincontains a number of convenience scripts for starting/stopping Docker, and the webserver/asset pipeline.
datacontains the sample data sets and fixtures used to setup demo tournaments and in automated tests respectively
docscontains our document source files and images (although some are linked from the root directory)
tabbycatis the main directory containing the Django project
localecontains translation strings for shared templates (others are in respective app directories)
utilscontains shared utilities
- All other folders are the Django apps that contain specific views, models, and templates for functions such as
drawgeneration/display, or recording
results. Each has sub-folders for tests and templates.
- Check that all migrations have been generated and committed into Git
- Bump version number in
- Bump version number and (if applicable) codename in
- Update the main
CHANGELOG.rstfile (including release date)
- Check the major current deployment options, including:
- The Tabbykitten version
- Docker (macOS, Windows 10*) and Docker Toolbox (Windows 10 Home) methods
- Using Bash and Powershell on Windows
- Using Terminal on macOS (at least test out a fresh install of the npm/pip dependencies)
- Check that the last Travis CI build passed and run the full local test suite (this will include the Selenium tests that are not on Travis)
- Shift remaining issues from the Github Milestone
- Create and finish the release branch as per git-flow
- Ensure the tag is correct (
vX.Y.Z) and published to GitHub
developto the in-progress feature branches
masterto the release pipeline repository
- Issue a formal release with change notes on GitHub
- Post change notes on the Facebook page/group