Skip to content

Latest commit

 

History

History
71 lines (53 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

71 lines (53 loc) · 1.74 KB

Contributing to AuthWeb

Thanks for your interest in contributing to AuthWeb! This document provides guidelines and instructions for contributing.

Code of Conduct

Our Standards

  • Use welcoming and inclusive language
  • Respect differing viewpoints
  • Accept constructive criticism
  • Focus on what's best for the community
  • Show empathy towards others

Our Responsibilities

  • Maintain project quality
  • Review contributions promptly
  • Provide constructive feedback
  • Foster an open environment

How to Contribute

  1. Fork the repository
  2. Create your branch (git checkout -b fix/some-broken-things)
  3. Make your changes
  4. Run tests if applicable
  5. Commit your changes (git commit -m 'Add AmazingFeature')
  6. Push to your branch (git push origin fix/some-broken-things)
  7. Open a Pull Request

Development Setup

git clone https://github.com/riipandi/authweb.git
cd authweb
pnpm install
pnpm dev

Development Guidelines

Code Style

  • Use TypeScript for type safety
  • Follow existing code formatting
  • Keep functions small and focused
  • Write descriptive variable names

Best Practices

  • Write tests for new features
  • Update documentation
  • Keep dependencies minimal
  • Optimize for performance
  • Follow security best practices

Commits

  • Use clear, descriptive commit messages
  • Reference issues when applicable
  • Keep commits focused and atomic

Need Help?

Resources

Getting Support

Your contributions help make AuthWeb better for everyone!