Skip to content

Commit 516aec0

Browse files
committedAug 16, 2024
docs: update CONTRIBUTING.md
- add PR instructions to CONTRIBUTING.md - almost disable Radon
1 parent 9d93915 commit 516aec0

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed
 

‎.github/workflows/radon.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ jobs:
3838
3939
if [ -n "$CHANGED_FILES" ]; then
4040
echo "Running Cyclomatic Complexity check..."
41-
radon cc $CHANGED_FILES -a -s -n E --exclude "AutoGGUF.quantize_model"
41+
radon cc $CHANGED_FILES -a -s -n F --exclude "AutoGGUF.quantize_model"
4242
4343
echo "Running Maintainability Index check..."
44-
radon mi $CHANGED_FILES -s -n E
44+
radon mi $CHANGED_FILES -s -n F
4545
else
4646
echo "No Python files to analyze."
4747
fi
@@ -56,8 +56,8 @@ jobs:
5656
fi
5757
5858
if [ -n "$CHANGED_FILES" ]; then
59-
CC_OUTPUT=$(radon cc $CHANGED_FILES -a -s -n E --exclude "AutoGGUF.quantize_model")
60-
MI_OUTPUT=$(radon mi $CHANGED_FILES -s -n E)
59+
CC_OUTPUT=$(radon cc $CHANGED_FILES -a -s -n F --exclude "AutoGGUF.quantize_model")
60+
MI_OUTPUT=$(radon mi $CHANGED_FILES -s -n F)
6161
6262
if [ -n "$CC_OUTPUT" ] || [ -n "$MI_OUTPUT" ]; then
6363
echo "Radon detected code complexity or maintainability issues:"

‎CONTRIBUTING.md

+2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ First off, thanks for taking the time to contribute! 🎉👍
1717

1818
### Your First Code Contribution
1919

20+
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.
21+
2022
1. Fork the repo
2123
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
2224
3. Install pre-commit: (`pip install pre-commit`)

0 commit comments

Comments
 (0)