Skip to content

Commit bd03fc4

Browse files
committed
docs(release): version 1.0.0
fix(pre-commit): add pygments dependency to rst-link. docs(contributing): add docs(readme): update
1 parent 93f0bdd commit bd03fc4

File tree

6 files changed

+435
-47
lines changed

6 files changed

+435
-47
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,4 @@ repos:
4242
hooks:
4343
- id: rst-lint
4444
exclude: ^docs
45+
additional_dependencies: [pygments]

CHANGELOG.rst

Lines changed: 53 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,57 @@
1-
=========
21
Changelog
32
=========
43

5-
Version 0.1
6-
===========
4+
All notable changes to this project will be documented in this file.
5+
6+
The format is based on `Keep a Changelog`_, and this project adheres to
7+
`Semantic Versioning`_.
8+
9+
`Unreleased`_
10+
-------------
11+
12+
Added
13+
~~~~~
14+
15+
Changed
16+
~~~~~~~
17+
18+
Removed
19+
~~~~~~~
20+
21+
`1.0.0`_ - 2024-11-21
22+
---------------------
23+
24+
.. _added-1:
25+
26+
Added
27+
~~~~~
28+
29+
- Include –pre-commit by default because –pre-commit-ruff extends
30+
–pre-commit.
31+
- Add ``ruff`` configuration to ``pyproject.toml`` because ``ruff`` does
32+
not support ``setup.cfg``.
33+
- Extend pre-commit template with ``ruff`` lint and fix.
34+
- Add ``mypy`` configuration to ``setup.cfg`` and template.
35+
36+
.. _changed-1:
37+
38+
Changed
39+
~~~~~~~
40+
41+
- Minimum ``tox`` version 4.2.23
42+
- Adopt ``ruff``, ``ruff-format``, ``codespell``, and ``rst-lint`` for
43+
project.
44+
45+
.. _removed-1:
46+
47+
Removed
48+
~~~~~~~
49+
50+
- ``isort`` configuration
51+
- ``flake8`` template and configuration
52+
- ``[testenv:publish]`` in ``tox.ini``
753

8-
- Feature A added
9-
- FIX: nasty bug #1729 fixed
10-
- add your changes here!
54+
.. _Keep a Changelog: https://keepachangelog.com/en/1.0.0/
55+
.. _Semantic Versioning: https://semver.org/spec/v2.0.0.html
56+
.. _Unreleased: https://github.com/jfishe/pyscaffoldext-pre-commit-ruff/compare/1.0.0...HEAD
57+
.. _1.0.0: https://github.com/jfishe/pyscaffoldext-pre-commit-ruff/compare/3e1993e7efea9da6d7e8007317cc6d3ea3333a65...1.0.0

0 commit comments

Comments
 (0)