Contributing
Thank you for your interest in contributing to Auth-Kit-JS!
Development Setup
- Clone the repository:
bash
git clone https://github.com/example/auth-kit-js.git
cd auth-kit-js- Install dependencies:
bash
npm install- Build the library:
bash
npm run build- Run tests:
bash
npm testDevelopment Commands
| Command | Description |
|---|---|
npm run build | Build the library |
npm run dev | Watch mode |
npm run test | Run tests |
npm run docs:dev | Start docs dev server |
npm run docs:build | Build docs for production |
Project Structure
auth-kit-js/
├── src/
│ ├── core/ # Types, errors, crypto
│ ├── providers/ # Google, Facebook, Telegram
│ ├── frontend/ # Browser helpers
│ ├── backend/ # Node.js handlers
│ └── adapters/ # Express integration
├── docs/ # VitePress documentation
├── examples/ # Usage examples
└── dist/ # Built outputPull Request Process
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Code Style
- Use TypeScript for all code
- Follow existing code patterns
- Add JSDoc comments for public APIs
- Write tests for new features
License
By contributing, you agree that your contributions will be licensed under the MIT License.