Thanks for helping to make Wn better!
Quick Links:
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)
- Testing automation: nox
- Unit/regression testing: pytest
- Packaging framework: Flit
- Coding style: PEP-8 (via Ruff)
- Type checking: Mypy
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
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.7.0 with Python 3.8 on Linux and [description of problem...]. Here's what I have tried:
>>> import wn >>> # some code ... # some result or error
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.
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 install Wn locally from source using Flit. Flit may be installed system-wide or within a virtual environment:
$ pip install flit
$ flit install -sThe -s option tells Flit to use symbolic links to install Wn,
similar to pip's -e editable installs. This allows one to edit source
files and use the changes without having to reinstall Wn each time.