Merge pull request #65 from sbillinge/precommit

pre-commit things

Author: sbillinge

.github/workflows/pre-commit.yml

@@ -14,6 +14,8 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
+      - name: Make prevent_commit_to_main.sh executable
+        run: chmod +x ./prevent_commit_to_main.sh
       - uses: pre-commit/[email protected]
         with:
           extra_args: --all-files

.github/workflows/testing.yml

@@ -49,8 +49,6 @@ jobs:
       - name: Validate diffpy.labpdfproc
         shell: bash -l {0}
         run: |
-          pwd
-          ls
           conda activate test
           coverage run -m pytest -s
           coverage report -m

.pre-commit-config.yaml

@@ -24,3 +24,10 @@ repos:
     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

@@ -85,3 +85,19 @@ An example input file can be found in the docs/examples directory in the distrib
 4. Run the command (see above)
 
 An example output is also present in the example data and you can compare your output to this file.  The example was processed with a muD of 2.5, though for experimentation you can try processing data with different muD values.
+
+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 `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

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