Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,9 @@ examples/.ipynb_checkpoints
# Node
node_modules
package-lock.json

# uv
uv.lock

# graft's local graph cache — regenerable, not committed (run `graft build`).
/graft/
5 changes: 5 additions & 0 deletions .ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# graft's cards are gitignored but should stay greppable: ripgrep reads
# .ignore before .gitignore, so this re-admits the tree to search only.
!graft/
graft/.cache/
graft/.graph/
8 changes: 4 additions & 4 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@ repos:
- id: end-of-file-fixer
- id: trailing-whitespace
- repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
rev: v9.26.0
rev: v9.27.0
hooks:
- id: commitlint
language_version: 20.17.0
stages:
- commit-msg
additional_dependencies: ['conventional-changelog-conventionalcommits@4.6.3']
- repo: https://github.com/pycqa/isort
rev: 9.0.1
rev: 9.0.2
hooks:
- id: isort
- repo: https://github.com/psf/black-pre-commit-mirror
rev: 26.5.1
rev: 26.10.0
hooks:
- id: black
- repo: https://github.com/codespell-project/codespell
Expand All @@ -37,7 +37,7 @@ repos:
- id: pydocstyle
additional_dependencies: ["tomli"]
- repo: https://github.com/PyCQA/flake8
rev: 7.3.0
rev: 7.4.1
hooks:
- id: flake8
ci:
Expand Down
28 changes: 14 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,32 @@

We would love for you to contribute to this package and help make it even better than it is today!
As a contributor, here are the guidelines we would like you to follow:
* [Issues and Bugs](#issue)
* [Feature Requests](#feature)
* [Submission Guidelines](#submit)
* [Issues and Bugs](#got-a-question-or-found-a-bug)
* [Feature Requests](#missing-a-feature)
* [Submission Guidelines](#submission-guidelines)

## <a name="issue"></a> Got a question or found a bug?
## Got a question or found a bug?

If you have a question or find a bug in the source code, you can help us by
[submitting an issue](#submit-issue) to our [GitHub Repository][github]. Even better, you can
[submit a Pull Request](#submit-pr) with a fix.
[submitting an issue](#submitting-an-issue) to our [GitHub Repository][github]. Even better, you can
[submit a Pull Request](#submitting-a-pull-request-pr) with a fix.

## <a name="feature"></a> Missing a Feature?
## Missing a Feature?

You can *request* a new feature by [submitting an issue](#submit-issue) to our
You can *request* a new feature by [submitting an issue](#submitting-an-issue) to our
[GitHub Repository][github]. If you would like to *implement* a new feature, please submit an
issue with a proposal for your work first, to be sure that we can use it. Then
[submit a Pull Request](#submit-pr) that points to this issue.
[submit a Pull Request](#submitting-a-pull-request-pr) that points to this issue.

Please consider what kind of change it is:
* For a **Major Feature**, first open an issue and outline your proposal so that it can be
discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
and help you to craft the change so that it is successfully accepted into the project.
* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
* **Small Features** can be crafted and directly [submitted as a Pull Request](#submitting-a-pull-request-pr).

## <a name="submit"></a> Submission Guidelines
## Submission Guidelines

### <a name="submit-issue"></a> Submitting an Issue
### Submitting an Issue

Before you submit an issue, please search the issue tracker, maybe an issue for your problem
already exists and the discussion might inform you of workarounds readily available.
Expand All @@ -37,7 +37,7 @@ and confirm it. In order to reproduce bugs we will need as much information as p
[Minimal Working Example](https://stackoverflow.com/help/minimal-reproducible-example), and
preferably be in touch with you to gather information.

### <a name="submit-pr"></a> Submitting a Pull Request (PR)
### Submitting a Pull Request (PR)

When you wish to contribute to the code base, please consider the following guidelines:
* Make a [fork](https://guides.github.com/activities/forking/) of this repository.
Expand Down Expand Up @@ -119,7 +119,7 @@ main (upstream) repository:
git pull --ff upstream main
```

### <a name="release"></a> Releasing a new version
### Releasing a new version

Releasing a new version can only be done by the maintainers.

Expand Down
4 changes: 4 additions & 0 deletions docs/source/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/* Keep section titles visible below the fixed header when following an anchor link */
section {
scroll-margin-top: 4rem;
}
3 changes: 2 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
html_static_path = ["_static"]
html_css_files = ["custom.css"]

html_theme_options = {
"metadata_distribution": package_name,
Expand Down
Loading