Merge pull request #1 from pythonnz/committee-adjustments

Adjust boiler plate text following committee meetings, add TODO

Author: dannyadair

.editorconfig

@@ -0,0 +1,10 @@
+[*.{css,js,json,less,md,py,rst,sass,scss,svg.j2,xml,yaml,yml}]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{json,yml,yaml,rst,md}]
+indent_size = 2

.github/workflows/pre-commit.yaml

@@ -0,0 +1,36 @@
+name: pre-commit
+
+on:
+  pull_request:
+    branches:
+      - "main*"
+  push:
+    branches:
+      - "main"
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Get python version
+        run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
+      - name: Install pre-commit
+        run: pip install pre-commit
+      - name: Run pre-commit
+        run: pre-commit run --all-files --show-diff-on-failure --color=always
+      - name: Check that all files generated by pre-commit are in git
+        run: |
+          newfiles="$(git ls-files --others --exclude-from=.gitignore)"
+          if [ "$newfiles" != "" ] ; then
+              echo "Please check-in the following files:"
+              echo "$newfiles"
+              exit 1
+          fi

.gitignore

@@ -0,0 +1,48 @@
+default_language_version:
+  python: python3
+  node: "22.9.0"
+repos:
+  - repo: local
+    hooks:
+      - id: prettier
+        name: prettier (with plugin-xml)
+        entry: prettier
+        args:
+          - --write
+          - --list-different
+          - --ignore-unknown
+        types: [text]
+        files: \.(css|htm|html|js|json|jsx|less|md|scss|toml|ts|xml|yaml|yml)$
+        language: node
+        additional_dependencies:
+          - "prettier@3.3.3"
+          - "@prettier/plugin-xml@3.4.1"
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: debug-statements
+      - id: fix-encoding-pragma
+        args: ["--remove"]
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-xml
+      - id: mixed-line-ending
+        args: ["--fix=lf"]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.8
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+  - repo: https://github.com/PyCQA/pylint
+    rev: v3.3.4
+    hooks:
+      - id: pylint
+      - id: pylint
+        additional_dependencies:
+          - "pdfbaker"

.pre-commit-config.yaml

@@ -1,38 +1,44 @@
 # Python New Zealand - Rules
 
-Official rules of [Python New Zealand](https://python.nz).<br>
-This repository holds the authoritative source code of the documents and tracks changes to them.
+Official rules of [Python New Zealand](https://python.nz).<br> This repository holds the
+authoritative source code of the documents and tracks changes to them.
 
-* Constitution
-* Bylaws
-* Code of Conduct
+- [Constitution](constitution/constitution.md)
+- Bylaws
+- Code of Conduct
 
 ## How to create documents
 
 ### Constitution
 
-This is Markdown source code to produce HTML (for https://python.nz) and PDF (for printing)<br>
-*Note: On github.com, bullet points will show in addition to numbering (styling is ignored)*
+This is Markdown source code to produce HTML (for https://python.nz) and PDF (for
+printing)<br> _Note: On github.com, bullet points will show in addition to numbering
+(styling is ignored). Also, clauses following a bullet list wrongly remain at the same
+indentation level as the bullet list - this seems to be a rendering bug in github. The
+HTML/PDF results look fine._
 
 #### Create HTML
 
 Use [pandoc](https://pandoc.org):
+
 ```
 pandoc -s constitution.md -o constitution.html -c constitution.css -V "pagetitle:Constitution"
 ```
-(`-s` standalone = embed external CSS, `pagetitle` to suppress title warning without inserting another headline)
+
+(`-s` standalone = embed external CSS, `pagetitle` to suppress title warning without
+inserting another headline)
 
 #### Table of Contents
 
-Optionally, `--toc` will also create a table of contents with headline links (handy but not fit for PDF)
+Optionally, `--toc` will also create a table of contents with headline links (handy but
+not fit for PDF)
+
 ```
 pandoc -s constitution.md -o constitution.html -c constitution.css -V "pagetitle:Constitution" --toc
 ```
 
 #### Create PDF
 
-Use [weasyprint](https://weasyprint.org) or similar, or just print from  your browser:
-```
-weasyprint constitution.html constitution.pdf
-```
-
+Just print the HTML from your browser to a PDF file.<br> If you want to use a dedicated
+conversion tool instead, check that it does the job correctly (the numbering of bullets
+and sub bullets is where [weasyprint](https://weasyprint.org/) failed)

README.md

@@ -0,0 +1,14 @@
+# Procedural changes and other consequences
+
+In order to actually follow our new constitution, we'll need to make some changes.
+
+- [ ] (Vice) President -> (Vice) Chairperson (email / alias, 1Password, website,
+      HelloClub)
+- [ ] Upon adoption at GM: confirm existing life members
+- [ ] Upon adoption at GM: confirm existing membership fees
+- [ ] Election process: only officers are elected by GM, positions within committee
+- [ ] Election process: must FIRST confirm they would stand if elected
+- [ ] Election process: must FIRST certify that they're not ineligible
+- [ ] Election process: counting scrutineers are 2 members who are not nominees
+- [ ] Election process create a bylaw for implementation details?
+- [ ] Charity return: Constitution needs review every 3 years