Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pre-commit checks #87

Merged
merged 6 commits into from
Sep 22, 2023
Merged
Show file tree
Hide file tree
Changes from 2 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
16 changes: 16 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
repos:
- repo: https://github.com/sphinx-contrib/sphinx-lint
egeakman marked this conversation as resolved.
Show resolved Hide resolved
rev: v0.6.8
hooks:
- id: sphinx-lint

- repo: https://github.com/psf/black
egeakman marked this conversation as resolved.
Show resolved Hide resolved
rev: 23.9.1
hooks:
- id: black

- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
hooks:
- id: end-of-file-fixer
- id: trailing-whitespace
egeakman marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
==============================
Python Documentation Community
Python Documentation Community
==============================

The following pages contain information about the documentation workgroup,
Expand Down
2 changes: 1 addition & 1 deletion docs/workgroup/milestones.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
Milestones and roadmaps
=======================

TBD
TBD
24 changes: 12 additions & 12 deletions docs/workgroup/workgroup_charter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,36 +27,36 @@ Active Time
-----------

This workgroup will be active indefinitely while supported by the Python
Steering Council.
Steering Council.

Core Values & Internal Government
---------------------------------

The core values for this group are:

- Respect
- Support
- Positive Atmosphere
- Constructiveness
- Integrity
- Respect
- Support
- Positive Atmosphere
- Constructiveness
- Integrity

The workgroup adopts the PSF Code of Conduct (https://www.python.org/psf/codeofconduct/).
Any actions (found by a majority) made against the principles in the Code of
Conduct will result in the acting person being removed from the workgroup.
Conduct will result in the acting person being removed from the workgroup.

Rules & Guidelines
------------------

- At any time the Python Steering Council may, at its discretion, add any number
of non-voting observers to the working group to observe and participate in
discussion.
discussion.
- The group's purview includes the Sphinx documentation included in the Python
source repository, including the doc theme, as well as separate projects such
as the developer guide. Translations and infrastructure will be managed by
Julien Palard or a Steering Council appointed member.
- The group will also maintain documentation of meetings and best practices.
- The editorial board will include people outside of the core developers who are
tech writers or educators.
tech writers or educators.

Decision Making Procedures
--------------------------
Expand All @@ -66,21 +66,21 @@ propose or request a topic for a decision.

- In general, a topic for decision should address one of the workgroup's goals:
- Improve or maintain the state of Python's documentation effort by some
noticeable or measurable amount.
noticeable or measurable amount.
- Increase the participation of contributors to documentation

When adding new members to the working group, prospective members must send an
email to introduce themselves along with a description of why they want to be
a member and what they bring to the process. Approval of new members will be
decided using the voting procedures detailed below.
decided using the voting procedures detailed below.

Voting
------

A vote for any proposal will last for 5 days, or when all voting members have
voted, whichever comes first. For a proposal to be successful it must have at
least two +1's, more +1's than -0's, and no -1. Voting may be done in any venue
given agreement of all voting members.
given agreement of all voting members.

Communication Plan
------------------
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ myst-parser
furo
sphinx-copybutton
sphinx-autobuild
pre-commit
egeakman marked this conversation as resolved.
Show resolved Hide resolved

# TODO remove docutils pin when this issue fixed:
# https://github.com/executablebooks/MyST-Parser/issues/612
Expand Down