Skip to content

Contribution

Yirgacheffe is an open source project and aims to support a wide range of use cases, and thus welcomes a wide range of inputs: be they usage based (this is broken.../this isn't explained well in the docs.../we could support this project if we just had this feature...), technically lead (there's a better/more efficient way of doing this...), etc.

Release process

Version numbers

When an update is about to be pushed to pypi, a new version number is needed. This is the rough algorithm used for the version number changes:

  • Major version number: API breaking changes, Major new feature areas
  • Minor version number: New APIs added, significant bug fixes
  • Point release number: Minor bug fixes and documentation improvements

There is always going to be awkward updates that break this, but this is the rough guide the project follows.

AI contributions

Currently LLMs or coding agents may not be used to produce code or documentation for Yirgacheffe. The aim of Yirgacheffe is to provide a small, reliable, well tested core on which other data-science pipelines are built. As such this project relies on the core contributors understanding the code base, and individual contributors understanding how their changes fit in with that.

In time this might change, but for now, whilst you can use whatever tools you like to help your own understanding, any contributions you make must be written by yourself.