Contributing

Thank you for your interest in contributing to SCF!

Fork Workflow

SCF uses the standard GitHub Fork workflow:

1. Fork the Repository

Go to github.com/SCF-org/scf and click Fork.

2. Clone Your Fork

bash

# Clone YOUR fork (not the original)
git clone https://github.com/YOUR_USERNAME/scf.git
cd scf

# Add upstream remote
git remote add upstream https://github.com/SCF-org/scf.git

3. Create a Branch

bash

# Sync with upstream first
git fetch upstream
git checkout main
git merge upstream/main

# Create feature branch
git checkout -b feature/your-feature

4. Make Changes

bash

# Install dependencies
npm install

# Make your changes...

# Run tests
npm test

# Build
npm run build

5. Commit and Push

bash

git add .
git commit -m "feat: add your feature"
git push origin feature/your-feature

6. Create Pull Request

Go to your fork on GitHub and click New Pull Request.

Commit Convention

feat: new feature
fix: bug fix
docs: documentation
test: tests
refactor: refactoring

Reporting Issues

Search existing issues first
Create new issue with:
- Steps to reproduce
- Expected vs actual behavior
- Environment (OS, Node.js version)

Questions?

Open a GitHub Discussion or Issue.

License

Contributions are licensed under MIT.