Skip to content

Contributing Guidelines

Thank you for contributing to AccessALI! This guide will help you get started.

Getting Started

  1. Set up your development environment
  2. Read the Development Workflow
  3. Review Coding Conventions
  4. Understand the Architecture

Development Process

1. Create a Branch

git checkout -b feature/my-feature

Branch naming:

  • feature/ - New features
  • fix/ - Bug fixes
  • docs/ - Documentation updates
  • chore/ - Maintenance tasks

2. Make Changes

Follow the Coding Conventions:

  • Use TypeScript
  • Follow layered architecture
  • Add proper validation
  • Include error handling
  • Write tests

3. Test Your Changes

# Type check
pnpm type-check

# Lint
pnpm lint

# Test
pnpm test

# Build
pnpm build

4. Commit

Follow Commit Conventions:

git add .
git commit -m "feat: add payment processing"

5. Push and Create PR

git push origin feature/my-feature

Create a pull request on GitHub.

Code Review

All code must be reviewed before merging.

See: Code Review Process

Questions?

  • Check documentation
  • Ask in team Slack
  • Create GitHub issue