Development guide

Here’s how to set up kafka-aggregator for local development.

1. Clone the kafka-aggregator repo from GitHub:

$ git clone https://github.com/lsst-sqre/kafka-aggregator.git

2. Install your local copy into a virtualenv:

$ cd kafka-aggregator
$ virtualenv -p Python3 venv
$ source venv/bin/activate
$ make update

3. Create a branch for local development:

$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

4. When you’re done making changes, check that your changes pass the lint checks, typing checks, and tests.

$ tox -e lint typing py37

5. Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

6. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated.
3. The pull request should work for Python 3.