From 516aec0a131aab2808cc878561e8ea9bac8c3071 Mon Sep 17 00:00:00 2001
From: BuildTools <chenxuzhang45@gmail.com>
Date: Fri, 16 Aug 2024 15:57:38 -0700
Subject: [PATCH] docs: update CONTRIBUTING.md

- add PR instructions to CONTRIBUTING.md
- almost disable Radon
---
 .github/workflows/radon.yml | 8 ++++----
 CONTRIBUTING.md             | 2 ++
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/.github/workflows/radon.yml b/.github/workflows/radon.yml
index d17fce0..9fb14c5 100644
--- a/.github/workflows/radon.yml
+++ b/.github/workflows/radon.yml
@@ -38,10 +38,10 @@ jobs:
         
         if [ -n "$CHANGED_FILES" ]; then
           echo "Running Cyclomatic Complexity check..."
-          radon cc $CHANGED_FILES -a -s -n E --exclude "AutoGGUF.quantize_model"
+          radon cc $CHANGED_FILES -a -s -n F --exclude "AutoGGUF.quantize_model"
           
           echo "Running Maintainability Index check..."
-          radon mi $CHANGED_FILES -s -n E
+          radon mi $CHANGED_FILES -s -n F
         else
           echo "No Python files to analyze."
         fi
@@ -56,8 +56,8 @@ jobs:
         fi
         
         if [ -n "$CHANGED_FILES" ]; then
-          CC_OUTPUT=$(radon cc $CHANGED_FILES -a -s -n E --exclude "AutoGGUF.quantize_model")
-          MI_OUTPUT=$(radon mi $CHANGED_FILES -s -n E)
+          CC_OUTPUT=$(radon cc $CHANGED_FILES -a -s -n F --exclude "AutoGGUF.quantize_model")
+          MI_OUTPUT=$(radon mi $CHANGED_FILES -s -n F)
           
           if [ -n "$CC_OUTPUT" ] || [ -n "$MI_OUTPUT" ]; then
             echo "Radon detected code complexity or maintainability issues:"
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8c31a3e..ea1dbe6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -17,6 +17,8 @@ ### Suggesting Enhancements
 
 ### Your First Code Contribution
 
+You can find issues labeled with "good first issue" in the Issues tab as a starting point. Code refactors and optimizations are also appreciated, although if there's a vulnrability please report it privately in the Security tab. For feature PRs, please make a discussion first to make sure your feature can be added and continously maintained.
+
 1. Fork the repo
 2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
 3. Install pre-commit: (`pip install pre-commit`)