Contributing

Thank you for considering contributing to NC-Scorer!

Getting Started

1. Fork the repository on GitHub
2. Clone your fork locally
3. Create a branch for your changes

Development Workflow

Setup

git clone https://github.com/YOUR-USERNAME/nc-scorer.git
cd nc-scorer
npm install
npm run dev

Making Changes

1. Create a descriptive branch:

   git checkout -b 123-fix-scoring-bug

2. Make your changes following our code style

3. Test your changes thoroughly

4. Commit using conventional commits:

   npm run commit

Submitting a Pull Request

1. Update your branch:

   git checkout main
   git pull upstream main
   git checkout your-branch
   git rebase main

2. Push your changes:

   git push origin your-branch

3. Create a Pull Request on GitHub

Code Guidelines

• Use Vue 3 Composition API
• Follow ESLint rules (run npm run lint)
• Add logging for important operations
• Update documentation if needed

Where to Contribute

• Bug fixes: Check issues
• Features: Discuss in GitHub Discussions first
• Documentation: Always welcome!

Questions?

Feel free to ask in the Discussions section.