Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Fork and clone the repository, then:
cd mkdocstrings make setup
If it fails for some reason, you'll need to install PDM manually.
You can install it with:
python3 -m pip install --user pipx pipx install pdm
Now you can try running
make setup again, or simply
You now have the dependencies installed.
make help to see all the available actions!
This project uses duty to run tasks. A Makefile is also provided. The Makefile will try to run certain tasks on multiple Python versions. If for some reason you don't want to run the task on multiple Python versions, you run the task directly with
pdm run duty TASK.
The Makefile detects if a virtual environment is activated, so
make will work the same with the virtualenv activated or not.
If you work in VSCode, see examples of tasks and run configurations.
- create a new branch:
git switch -c feature-or-bugfix-name
- edit the code and/or the documentation
make formatto auto-format the code
make checkto check everything (fix any warning)
make testto run the tests (fix any issue)
- if you updated the documentation or the project dependencies:
- go to http://localhost:8000 and check that everything looks good
- follow our commit message convention
If you are unsure about how to fix or ignore a warning, just let the continuous integration fail, and we will help you during the review.
Don't bother updating the changelog, we will take care of this.
Commit message convention¤
<type>[(scope)]: Subject [Body]
Subject and body must be valid Markdown. Subject must have proper casing (uppercase for first letter if it makes sense), but no dot at the end, and no punctuation in general.
Scope and body are optional. Type can be:
build: About packaging, building wheels, etc.
chore: About packaging or repo/files management.
ci: About Continuous Integration.
deps: Dependencies update.
docs: About documentation.
feat: New feature.
fix: Bug fix.
perf: About performance.
refactor: Changes that are not features or bug fixes.
style: A change in code style/format.
tests: About tests.
If you write a body, please add trailers at the end (for example issues and PR references, or co-authors), without relying on GitHub's flavored Markdown:
Body. Issue #10: https://github.com/namespace/project/issues/10 Related to PR namespace/other-project#15: https://github.com/namespace/other-project/pull/15
These "trailers" must appear at the end of the body, without any blank lines between them. The trailer title can contain any character except colons
:. We expect a full URI for each trailer, not just GitHub autolinks (for example, full GitHub URLs for commits and issues, not the hash or the #issue-number).
We do not enforce a line length on commit messages summary and body, but please avoid very long summaries, and very long lines in the body, unless they are part of code blocks that must not be wrapped.
Pull requests guidelines¤
Link to any related issue in the Pull Request message.
During the review, we recommend using fixups:
# SHA is the SHA of the commit you want to fix git commit --fixup=SHA
Once all the changes are approved, you can squash your commits:
git rebase -i --autosquash main
git push -f
If this seems all too complicated, you can push or force-push each new commit, and we will squash them ourselves if needed, before merging.