Merge branch 'conf' of github.com:cadenmyers13/diffpy.pdfmorph into conf

Author: cadenmyers13

.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+default_language_version:
+    python: python3
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/ambv/black
+    rev: 23.3.0
+    hooks:
+      - id: black
+  - repo: https://github.com/pycqa/flake8
+    rev: 6.0.0
+    hooks:
+      - id: flake8
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        args: ["--profile", "black"]
+  - repo: https://github.com/kynan/nbstripout
+    rev: 0.6.1
+    hooks:
+      - id: nbstripout
+  - repo: local
+    hooks:
+      - id: prevent-commit-to-main
+        name: Prevent Commit to Main Branch
+        entry: ./prevent_commit_to_main.sh
+        language: script
+        stages: [commit]

README.rst

@@ -150,6 +150,24 @@ rather than copied to a system directory, use ::
 
      python -m pip install -e .
 
+CONTRIBUTING
+------------------------------------------------------------------------
+We welcome contributors from the community.  Please consider posting issues, and taking issues and posting PRs.
+
+To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit
+hooks.
+
+1. modify the permissions to executable on the bash script called ``prevent_commit_to_main.sh`` in this directory: ``chmod +x prevent_commit_to_main.sh``
+
+2. install pre-commit in your working environment with ``conda install pre-commit``
+
+3. initialize pre-commit (one time only) ``pre-commit install``
+
+Thereafter your code will be linted by black and isort and checked against flake8 before you can commit.
+If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should
+pass after they are modified).  If the flake8 test fails please see the error messages and fix them manually before
+trying to commit again
+
 
 CONTACTS
 ------------------------------------------------------------------------

doc/manual/source/conf.py

@@ -7,7 +7,7 @@
 # -- Path setup --------------------------------------------------------------
 
 # If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
+# add these directories to pathlib.Path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import sys

prevent_commit_to_main.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+##!"C:\\Program Files\\Git\\usr\\bin\\bash.exe"
+
+branch="$(git rev-parse --abbrev-ref HEAD)"
+
+if [ "$branch" = "main" ]; then
+echo "You are on the main branch. Committing to the main branch is not allowed."
+exit 1
+fi