mirror of
https://github.com/alirezarezvani/ClaudeForge.git
synced 2026-07-03 02:13:15 -04:00
Initial commit: ClaudeForge v1.0.0
This commit is contained in:
@@ -0,0 +1,129 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, religion, or sexual identity
|
||||
and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the
|
||||
overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or
|
||||
advances of any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email
|
||||
address, without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
[INSERT CONTACT METHOD].
|
||||
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series
|
||||
of actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or
|
||||
permanent ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within
|
||||
the community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.0, available at
|
||||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||
|
||||
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||
enforcement ladder](https://github.com/mozilla/diversity).
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
https://www.contributor-covenant.org/faq. Translations are available at
|
||||
https://www.contributor-covenant.org/translations.
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Report a bug or issue with ClaudeForge
|
||||
title: '[BUG] '
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Bug Description
|
||||
|
||||
A clear and concise description of the bug.
|
||||
|
||||
## Steps to Reproduce
|
||||
|
||||
1. Go to '...'
|
||||
2. Run command '...'
|
||||
3. See error '...'
|
||||
|
||||
## Expected Behavior
|
||||
|
||||
What you expected to happen.
|
||||
|
||||
## Actual Behavior
|
||||
|
||||
What actually happened.
|
||||
|
||||
## Environment
|
||||
|
||||
- **OS:** [e.g., macOS 13.5, Windows 11, Ubuntu 22.04]
|
||||
- **Claude Code Version:** [e.g., 2.1.0]
|
||||
- **ClaudeForge Version:** [e.g., 1.0.0]
|
||||
- **Installation Method:** [user-level / project-level]
|
||||
|
||||
## Additional Context
|
||||
|
||||
Add any other context, screenshots, or logs about the problem.
|
||||
|
||||
## Relevant Files
|
||||
|
||||
If applicable, attach:
|
||||
- Error logs
|
||||
- Generated CLAUDE.md file
|
||||
- Project structure
|
||||
|
||||
## Possible Solution
|
||||
|
||||
If you have ideas on how to fix this, please share.
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Suggest a new feature or enhancement for ClaudeForge
|
||||
title: '[FEATURE] '
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Feature Description
|
||||
|
||||
A clear and concise description of the feature you'd like to see.
|
||||
|
||||
## Problem It Solves
|
||||
|
||||
What problem does this feature address? Why is it needed?
|
||||
|
||||
## Proposed Solution
|
||||
|
||||
Describe how you envision this feature working.
|
||||
|
||||
## Alternatives Considered
|
||||
|
||||
What other approaches did you consider? Why is your proposal better?
|
||||
|
||||
## Use Case
|
||||
|
||||
Provide a specific example of how you would use this feature.
|
||||
|
||||
**Example:**
|
||||
```
|
||||
/enhance-claude-md --with-new-feature
|
||||
|
||||
# Result: [Expected outcome]
|
||||
```
|
||||
|
||||
## Additional Context
|
||||
|
||||
Add any other context, screenshots, or mockups about the feature request.
|
||||
|
||||
## Implementation Ideas
|
||||
|
||||
If you have technical ideas on how to implement this, please share.
|
||||
|
||||
## Would You Contribute?
|
||||
|
||||
- [ ] I'd like to work on this feature myself
|
||||
- [ ] I can help test this feature
|
||||
- [ ] I'm just suggesting an idea
|
||||
@@ -0,0 +1,58 @@
|
||||
# Pull Request
|
||||
|
||||
## Description
|
||||
|
||||
Provide a clear and concise description of your changes.
|
||||
|
||||
## Type of Change
|
||||
|
||||
- [ ] Bug fix (non-breaking change fixing an issue)
|
||||
- [ ] New feature (non-breaking change adding functionality)
|
||||
- [ ] Breaking change (fix or feature causing existing functionality to change)
|
||||
- [ ] Documentation update
|
||||
- [ ] Code refactoring
|
||||
- [ ] Performance improvement
|
||||
- [ ] Test addition/improvement
|
||||
|
||||
## Related Issues
|
||||
|
||||
Fixes #(issue_number)
|
||||
|
||||
## Changes Made
|
||||
|
||||
- Change 1
|
||||
- Change 2
|
||||
- Change 3
|
||||
|
||||
## Testing Performed
|
||||
|
||||
Describe the tests you ran to verify your changes:
|
||||
|
||||
- [ ] Tested installation (./install.sh)
|
||||
- [ ] Tested slash command (/enhance-claude-md)
|
||||
- [ ] Tested guardian agent
|
||||
- [ ] Tested on new project
|
||||
- [ ] Tested on existing project with CLAUDE.md
|
||||
- [ ] Tested modular architecture
|
||||
|
||||
**Test Environment:**
|
||||
- OS: [e.g., macOS 13.5]
|
||||
- Claude Code Version: [e.g., 2.1.0]
|
||||
|
||||
## Screenshots (if applicable)
|
||||
|
||||
Add screenshots to help explain your changes.
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] My code follows the project's style guidelines
|
||||
- [ ] I have commented my code where necessary
|
||||
- [ ] I have updated the documentation (if needed)
|
||||
- [ ] I have updated CHANGELOG.md with my changes
|
||||
- [ ] My changes generate no new warnings
|
||||
- [ ] I have tested my changes thoroughly
|
||||
- [ ] All existing tests still pass
|
||||
|
||||
## Additional Notes
|
||||
|
||||
Any additional information reviewers should know.
|
||||
@@ -0,0 +1,162 @@
|
||||
name: Validate ClaudeForge
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main, develop ]
|
||||
pull_request:
|
||||
branches: [ main, develop ]
|
||||
|
||||
jobs:
|
||||
validate-python:
|
||||
name: Validate Python Modules
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.9'
|
||||
|
||||
- name: Check Python syntax
|
||||
run: |
|
||||
python3 -m py_compile skill/analyzer.py
|
||||
python3 -m py_compile skill/validator.py
|
||||
python3 -m py_compile skill/generator.py
|
||||
python3 -m py_compile skill/template_selector.py
|
||||
python3 -m py_compile skill/workflow.py
|
||||
|
||||
- name: Test module imports
|
||||
run: |
|
||||
cd skill
|
||||
python3 -c "from analyzer import CLAUDEMDAnalyzer; print('analyzer.py: OK')"
|
||||
python3 -c "from validator import BestPracticesValidator; print('validator.py: OK')"
|
||||
python3 -c "from generator import ContentGenerator; print('generator.py: OK')"
|
||||
python3 -c "from template_selector import TemplateSelector; print('template_selector.py: OK')"
|
||||
python3 -c "from workflow import InitializationWorkflow; print('workflow.py: OK')"
|
||||
|
||||
validate-structure:
|
||||
name: Validate Repository Structure
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Check required files
|
||||
run: |
|
||||
test -f README.md || exit 1
|
||||
test -f CHANGELOG.md || exit 1
|
||||
test -f LICENSE || exit 1
|
||||
test -f CLAUDE.md || exit 1
|
||||
test -f install.sh || exit 1
|
||||
test -f install.ps1 || exit 1
|
||||
|
||||
- name: Check required directories
|
||||
run: |
|
||||
test -d skill || exit 1
|
||||
test -d command || exit 1
|
||||
test -d agent || exit 1
|
||||
test -d docs || exit 1
|
||||
test -d examples || exit 1
|
||||
|
||||
- name: Check skill files
|
||||
run: |
|
||||
test -f skill/SKILL.md || exit 1
|
||||
test -f skill/analyzer.py || exit 1
|
||||
test -f skill/validator.py || exit 1
|
||||
test -f skill/generator.py || exit 1
|
||||
test -f skill/template_selector.py || exit 1
|
||||
test -f skill/workflow.py || exit 1
|
||||
|
||||
- name: Check command files
|
||||
run: |
|
||||
test -f command/enhance-claude-md.md || exit 1
|
||||
|
||||
- name: Check agent files
|
||||
run: |
|
||||
test -f agent/claude-md-guardian.md || exit 1
|
||||
|
||||
validate-documentation:
|
||||
name: Validate Documentation
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Check docs directory
|
||||
run: |
|
||||
test -f docs/INSTALLATION.md || exit 1
|
||||
test -f docs/QUICK_START.md || exit 1
|
||||
test -f docs/ARCHITECTURE.md || exit 1
|
||||
test -f docs/TROUBLESHOOTING.md || exit 1
|
||||
test -f docs/CONTRIBUTING.md || exit 1
|
||||
|
||||
- name: Check examples directory
|
||||
run: |
|
||||
test -f examples/basic-usage.md || exit 1
|
||||
test -f examples/modular-setup.md || exit 1
|
||||
test -f examples/integration-examples.md || exit 1
|
||||
|
||||
validate-installers:
|
||||
name: Validate Installer Scripts
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-latest, macos-latest]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Check install.sh syntax
|
||||
if: matrix.os != 'windows-latest'
|
||||
run: |
|
||||
bash -n install.sh
|
||||
|
||||
- name: Test install.sh (dry run)
|
||||
if: matrix.os != 'windows-latest'
|
||||
run: |
|
||||
# Create temporary directory
|
||||
mkdir -p /tmp/test-claude
|
||||
export HOME=/tmp/test-claude
|
||||
|
||||
# Test script runs without errors
|
||||
# (Don't actually install, just check syntax and structure)
|
||||
grep -q "claudeforge-skill" install.sh || exit 1
|
||||
grep -q "enhance-claude-md" install.sh || exit 1
|
||||
grep -q "claude-md-guardian" install.sh || exit 1
|
||||
|
||||
lint-markdown:
|
||||
name: Lint Markdown Files
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Check markdown files exist
|
||||
run: |
|
||||
find . -name "*.md" -type f | wc -l
|
||||
|
||||
- name: Basic markdown validation
|
||||
run: |
|
||||
# Check for broken reference-style links
|
||||
! grep -r "\[.*\]\[.*\]" --include="*.md" . | grep -v "http" | grep -v ".md"
|
||||
|
||||
security-check:
|
||||
name: Security Checks
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Check for hardcoded secrets
|
||||
run: |
|
||||
# Check for common secret patterns
|
||||
! grep -r "API_KEY\s*=" . --include="*.py" --include="*.md"
|
||||
! grep -r "password\s*=" . --include="*.py" --include="*.md"
|
||||
! grep -r "token\s*=" . --include="*.py" --include="*.md"
|
||||
|
||||
- name: Check for TODO/FIXME
|
||||
run: |
|
||||
# Warn about TODO/FIXME (not fail)
|
||||
grep -r "TODO\|FIXME" . --include="*.py" --include="*.md" || true
|
||||
Reference in New Issue
Block a user