Development

Versioning and RFC2812

Bottom follows semver for its public API.

• only the documented Public API is subject to versioning. anything not documented there may change at any time.

• new IRC replies/codes may be added in patch versions.

• internal classes and methods may be promoted to public methods in minor versions.

Contributing

Contributions welcome! Please run make pr-check locally before submitting a PR.

If you’d like to contribute but aren’t sure where to start, consider looking through the open issues!

Some pointers are available here to help you start navigating the codebase.

Development

bottom uses ruff and pytest. To get started:

$ git clone https://github.com/numberoverzero/bottom.git
$ cd bottom
$ make dev
# ... make some changes
$ make pr-check

Documentation

Documentation improvements are especially appreciated. For small changes, open a pull request! If there’s an area you feel is lacking and will require more than a small change, open an issue to discuss the problem - others are probably also confused, and may have suggestions to improve the same area.