All contributions are very welcome!
Make sure to read the code of conduct and follow its recommendations.
If you have a specific suggestion for how bibat could be improved, or if you find a bug then please file an issue or submit a pull request.
Alternatively, if you have any more general thoughts or questions, please post them in the discussions page.
If you would like to contribute code changes, just follow the normal GitHub workflow: make a local branch with the changes then create a pull request.
To develop bibat locally you will probably need to install it with development dependencies. Here is how to do so:
$ pip install bibat'[development]'You can see what these dependencies are by checking the
[project.optional-dependencies] table in bibat's pyproject.toml file. Some
important ones are black,
isort,
pre-commit and tox.
Another thing you will want to do while developing bibat locally is use it to
create projects. For this I recommend avoiding having to complete the wizard
every time by using copier's --defaults (abbreviation -l) option, e.g.
$ copier copy -l --vcs-ref HEAD bibat my_cool_projectBibat depends on cmdstan, which can
be tricky to install. If you run the commands make env or make analysis
from a bibat project, it will attempt to install cmdstan automatically. If
this doesn't work, please check the cmdstan and cmdstanpy documentation.
To release a new version of bibat, edit the field version in the file
pyproject.toml, e.g. to 0.2.1 then make a pull request with this change.
Once the changes are merged into the origin/main branch, add a tag whose name
begins with v, followed by the new version number to your local main branch,
for example like this:
$ git tag v0.2.1Now push the new tag to GitHub:
$ git push origin "v0.2.1"