Skip to content

Add guidelines regarding how to test plugins #937

Open
@ghisvail

Description

@ghisvail

Description

I recently designed and published a Commitizen plugin to recognize the commit style used by part of the PyData stack (NumPy, SciPy, Pandas, ...) and generate a KAC-like change log automatically from relevant commits.

The code for it is there if you're interested.

I found the documentation for designing plugins very good. I followed these steps and was able to test everything with dry runs and on the actual project change log.

That being said, I would like to add a test suite to avoid accidental regressions in the future. That part is not covered by the documentation, and code examples are scattered in the main commitizen repo.

Could you enhance the documentation by providing additional tips and guidelines to write an appropriate test suite for plugin designers?

Cheers,
Ghis

Possible Solution

No response

Additional context

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions