leafspark
/
AutoGGUF
mirror of https://github.com/leafspark/AutoGGUF
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: update CONTRIBUTING.md 

- add PR instructions to CONTRIBUTING.md
- almost disable Radon
This commit is contained in:
BuildTools 2024-08-16 15:57:38 -07:00
parent 9d939151de
commit 516aec0a13
No known key found for this signature in database
GPG Key ID: 3270C066C15D530B
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.github/workflows/radon.yml vendored
View File

@ -38,10 +38,10 @@ jobs:
if [ -n "$CHANGED_FILES" ]; then if [ -n "$CHANGED_FILES" ]; then
echo "Running Cyclomatic Complexity check..." 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..." echo "Running Maintainability Index check..."
radon mi $CHANGED_FILES -s -n E radon mi $CHANGED_FILES -s -n F
else else
echo "No Python files to analyze." echo "No Python files to analyze."
fi fi
@ -56,8 +56,8 @@ jobs:
fi fi
if [ -n "$CHANGED_FILES" ]; then if [ -n "$CHANGED_FILES" ]; then
CC_OUTPUT=$(radon cc $CHANGED_FILES -a -s -n E --exclude "AutoGGUF.quantize_model") CC_OUTPUT=$(radon cc $CHANGED_FILES -a -s -n F --exclude "AutoGGUF.quantize_model")
MI_OUTPUT=$(radon mi $CHANGED_FILES -s -n E) MI_OUTPUT=$(radon mi $CHANGED_FILES -s -n F)
if [ -n "$CC_OUTPUT" ] || [ -n "$MI_OUTPUT" ]; then if [ -n "$CC_OUTPUT" ] || [ -n "$MI_OUTPUT" ]; then
echo "Radon detected code complexity or maintainability issues:" echo "Radon detected code complexity or maintainability issues:"

2
CONTRIBUTING.md
View File

@ -17,6 +17,8 @@ ### Suggesting Enhancements
### Your First Code Contribution ### 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 1. Fork the repo
2. Create your feature branch (`git checkout -b feature/AmazingFeature`) 2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Install pre-commit: (`pip install pre-commit`) 3. Install pre-commit: (`pip install pre-commit`)