Skip to content

Commit

Permalink
docs(release): version 1.0.0
Browse files Browse the repository at this point in the history
fix(pre-commit): add pygments dependency to rst-link.

docs(contributing): add
docs(readme): update
  • Loading branch information
jfishe committed Nov 21, 2024
1 parent 93f0bdd commit bd03fc4
Show file tree
Hide file tree
Showing 6 changed files with 435 additions and 47 deletions.
1 change: 1 addition & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,4 @@ repos:
hooks:
- id: rst-lint
exclude: ^docs
additional_dependencies: [pygments]
59 changes: 53 additions & 6 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,57 @@
=========
Changelog
=========

Version 0.1
===========
All notable changes to this project will be documented in this file.

The format is based on `Keep a Changelog`_, and this project adheres to
`Semantic Versioning`_.

`Unreleased`_
-------------

Added
~~~~~

Changed
~~~~~~~

Removed
~~~~~~~

`1.0.0`_ - 2024-11-21
---------------------

.. _added-1:

Added
~~~~~

- Include –pre-commit by default because –pre-commit-ruff extends
–pre-commit.
- Add ``ruff`` configuration to ``pyproject.toml`` because ``ruff`` does
not support ``setup.cfg``.
- Extend pre-commit template with ``ruff`` lint and fix.
- Add ``mypy`` configuration to ``setup.cfg`` and template.

.. _changed-1:

Changed
~~~~~~~

- Minimum ``tox`` version 4.2.23
- Adopt ``ruff``, ``ruff-format``, ``codespell``, and ``rst-lint`` for
project.

.. _removed-1:

Removed
~~~~~~~

- ``isort`` configuration
- ``flake8`` template and configuration
- ``[testenv:publish]`` in ``tox.ini``

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

0 comments on commit bd03fc4

Please sign in to comment.