flake8-github

This extension seamlessly integrates with Flake8, providing clear and elegant error annotations directly on GitHub's interface, making it easier than ever to identify and address code issues during pull request reviews.

Table of Contents

• flake8-github
  • Table of Contents
  • Installation
  • Usage
  • Local Development Setup
  • Contributing
  • License

Installation

Prerequisites

• flake8 = ^6.0.0

You can install flake8-github using pip:

$ pip install flake8-github

Usage

After installing the formatter, you can enable it in your Flake8 configuration. For example, in your .flake8, setup.cfg file:

[flake8]
format = github

Run Flake8 as usual to start using github formatter:

$ flake8 src/ --format=github

Local Development Setup

To contribute to this project or develop the plugin further locally, follow these steps:

1. Clone the repository:

$ git clone <https://github.com/your-username/flake8-github.git>
$ cd flake8-github

2. Create a virtual environment and install development dependencies:

$ pip install pre-commit poetry
$ pre-commit install
$ poetry install

3. How to bumpversion when you are done with the changes:

$ poetry self add poetry-bumpversion
$ poetry version {major, minor, patch, etc.}

Now you're ready to make changes and test your plugin locally.

Contributing

Contributions are welcome! Please follow these guidelines:

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/my-feature).
3. Commit your changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin feature/my-feature).
5. Create a new Pull Request.

Please ensure your code adheres to the project's coding standards and includes tests.

License

This project is licensed under MIT License - see the LICENSE file for details.