Skip to main content

Contributing to DELEGATOR

AI-Generated Content

This documentation page was initially generated by AI to bootstrap the documentation structure. Content may be incomplete or contain inaccuracies. We welcome contributions to improve it.

Thank you for your interest in contributing to DELEGATOR! This guide will help you get started.

Ways to Contribute​

  • Bug Reports - Report issues you encounter
  • Feature Requests - Suggest new features
  • Code Contributions - Submit pull requests
  • Documentation - Improve these docs
  • Testing - Help test new releases

Getting Started​

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Create a branch for your changes
  4. Make your changes following our guidelines
  5. Submit a pull request

Development Workflow​

Branch Naming​

Use descriptive branch names:

  • feature/batch-registration
  • fix/payment-calculation
  • docs/supervisor-guide

Commit Messages​

Follow Conventional Commits:

feat: add bulk email functionality

- Add template selection
- Implement recipient filtering
- Add preview before send

Prefixes:

  • feat: - New feature
  • fix: - Bug fix
  • docs: - Documentation
  • refactor: - Code refactoring
  • test: - Tests
  • chore: - Maintenance

Code Style​

Svelte Components​

  • Use TypeScript in <script lang="ts">
  • Keep components focused
  • Use props for customization

TypeScript​

  • Enable strict mode
  • Define explicit types
  • Avoid any

Formatting​

Format code with Prettier:

bun run format

Lint code:

bun run lint

Testing​

Write tests for new features:

bun test

Pull Request Process​

  1. Ensure tests pass
  2. Update documentation if needed
  3. Fill out PR template
  4. Request review

Code Review​

  • At least one approval required
  • Address feedback constructively
  • Squash commits if requested

Community​

  • Be respectful and inclusive
  • Help others learn
  • Celebrate contributions

License​

Contributions are licensed under AGPL-3.0.