CONTRIBUTING.md

Contributing to Wn

Thanks for helping to make Wn better!

Quick Links:

• Report a bug or request a features
• Ask a question
• View documentation

Developer Information:

• Versioning scheme: Semantic Versioning
• Branching scheme: GitHub Flow
• Changelog: keep a changelog
• Documentation framework: Sphinx
• Docstring style: Google Python Style Guide (via sphinx.ext.napoleon)
• Unit/regression testing: pytest
• Packaging framework: Hatch
• Coding style: PEP-8 (via Ruff)
• Type checking: Mypy

Get Help

Confused about wordnets in general? See the Global Wordnet Association Documentation

Confused about using Wn or wish to share some tips? Start a discussion

Encountering a problem with Wn or wish to propose a new features? Raise an issue

Report a Bug

When reporting a bug, please provide enough information for someone to reproduce the problem. This might include the version of Python you're running, the version of Wn you have installed, the wordnet lexicons you have installed, and possibly the platform (Linux, Windows, macOS) you're on. Please give a minimal working example that illustrates the problem. For example:

I'm using Wn 0.9.5 with Python 3.11 on Linux and [description of problem...]. Here's what I have tried:

>>> import wn
>>> # some code
... # some result or error

Request a Feature

If there's a feature that you think would make a good addition to Wn, raise an issue describing what the feature is and what problems it would address.

Guidelines for Contributing

See the "developer information" above for a brief description of guidelines and conventions used in Wn. If you have a fix, please submit a pull request to the main branch. In general, every pull request should have an associated issue.

Developers should run and test Wn locally from source using Hatch. Hatch may be installed system-wide or within a virtual environment:

$ pip install hatch

You can then use the hatch commands like the following:

$ hatch shell           # activate a Wn virtual environment
$ hatch fmt --check     # lint the code and check code style
$ hatch run mypy:check  # type check with mypy
$ hatch test            # run unit tests
$ hatch build           # build a source distribution and wheel
$ hatch publish         # publish build artifacts to PyPI