Add PR size labeler (#1)

* Add PR checks workflow

* pre-commit run on README

* try to auto add labels

Author: ProKil

.github/workflows/pr-checks.yaml

@@ -0,0 +1,30 @@
+name: Checks on PRs
+
+on: [pull_request]
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  labeler:
+    runs-on: ubuntu-latest
+    name: Label the PR size
+    steps:
+      - uses: codelytv/pr-size-labeler@v1
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          xs_label: 'size/xs'
+          xs_max_size: '10'
+          s_label: 'size/s'
+          s_max_size: '100'
+          m_label: 'size/m'
+          m_max_size: '500'
+          l_label: 'size/l'
+          l_max_size: '1000'
+          xl_label: 'size/xl'
+          fail_if_xl: 'True'
+          message_if_xl: >
+            This PR exceeds the recommended size of 1000 lines.
+            Please make sure you are NOT addressing multiple issues with one PR.
+            Note this PR might be rejected due to its size.
+          files_to_ignore: ''

README.md

@@ -8,8 +8,10 @@ This template, designed as the optimal springboard for your open-source Python r
 4. Desire to decrease the number of frustrating Runtime Errors encountered during experiment execution.
 
 > [!NOTE]
-> This repo is under construction. 
+> This repo is under construction.
 
+## Pull Requests
+A PR typically implements a new feature, improves an old feature, or fixes a bug.
 
 ## Typing
 ### Static type checking
@@ -21,4 +23,4 @@ This template, designed as the optimal springboard for your open-source Python r
 
 ## Contribution
 
-I welcome all kinds of contribution, e.g. adding more tools, better practices, discussions on trade-offs. 
+I welcome all kinds of contribution, e.g. adding more tools, better practices, discussions on trade-offs.