If you want to contribute to coBib feel free to open a PR on Gitlab. Bug fixes and feature additions are always welcome! If you need some inspiration you also take a look at the list of open issues to see whether there is something you can help with.
We are using tox for a unified testing experience between local installations and the CI.
Thus, after installing tox (pip install tox) you can inspect the available environments with tox -l.
You can also inspect tox.ini and install the required development tools manually.
I choose not to duplicate the information in another file, because this is likely to become outdated when it is not being used regularly.
You can run the tests locally with
tox -e py39
or if you want to run only some specific tests:
pytest tests/PATH_TO_TEST.py -k FUNCTION_NAME
Please also check your code style with the following checks:
tox -e lint
You can check the coverage with:
tox -e coverage
When working on coBib you may find the online documentation at https://cobib.gitlab.io/cobib/cobib.html or a locally generated version, useful. For the latter, please refer to the README.
Once you have opened a merge request on GitLab, you can also view an automatically generated version of the documentation for your branch through the View App button below the Pipeline results.
To create a new release you should do the following steps:
0. Update the version number in src/cobib/__init__.py and the man page
- Update the changelog including the link to pypi
- Commit, tag and push to Gitlab
- Ensure you have the following packages installed:
pip install build twine - Create the release wheel and archive files:
python -m build - Publish the new release on pypi:
python -m twine upload dist/cobib-VERSION* - Create a release on Gitlab (and Github) by adding the changelog section to the tag release notes
- Trigger the manual CI action
pages, which will update the online documentation.