Contributing¶
There are many ways to contribute to the Jamdict project. The one that Jamdict development team are focusing on at the moment are:
Fixing existing bugs
Improving query functions
Improving documentation
Keeping jamdict database up to date
If you have some suggestions or bug reports, please share on jamdict issues tracker.
Fixing bugs¶
If you found a bug please report at https://github.com/neocl/jamdict/issues
When it is possible, please also share how to reproduce the bugs and a snapshot of jamdict info to help with the bug finding process.
python3 -m jamdict info
Pull requests are welcome.
Updating Documentation¶
Fork jamdict repository to your own Github account.
Clone jamdict repository to your local machine.
git clone https://github.com/<your-account-name>/jamdict
Create a virtual environment (optional, but highly recommended)
# if you use virtualenvwrapper mkvirtualenv jamdev workon jamdev # if you use Python venv python3 -m venv .env . .env/bin/activate python3 -m pip install --upgrade pip wheel Sphinx
Build the docs
cd jamdict/docs # compile the docs make dirhtml # serve the docs using Python3 built-in development server # Note: this requires Python >= 3.7 to support --directory python3 -m http.server 7000 --directory _build/dirhtml # if you use earlier Python 3, you may use cd _build/dirhtml python3 -m http.server 7000
Now the docs should be ready to view at http://localhost:7000 . You can visit that URL on your browser to view the docs.
More information:
Sphinx tutorial: https://sphinx-tutorial.readthedocs.io/start/
Using virtualenv: https://virtualenvwrapper.readthedocs.io/en/latest/install.html
Using venv: https://docs.python.org/3/library/venv.html
Development¶
Development contributions are welcome. Setting up development environment for Jamdict should be similar to Updating Documentation.
Please contact the development team if you need more information: https://github.com/neocl/jamdict/issues