Getting started
We welcome contributions to Sorionlib! This guide will help you get started.Repository structure
Setting up locally
- Fork the repository Click the “Fork” button on GitHub.
-
Clone your fork
-
Install dependencies
-
Create a branch
-
Run the development server
Running tests
Code style
We use ESLint and Prettier for code formatting. Run the linter before committing:Style guidelines
- Use TypeScript for all new code
- Use
async/awaitinstead of callbacks - Use meaningful variable and function names
- Add JSDoc comments for public APIs
- Keep functions small and focused
- Write tests for new features
Example code style
Pull request guidelines
Before submitting
- Update tests - Add or update tests for your changes
- Update documentation - Document new features or changes
- Run the test suite - Ensure all tests pass
- Run the linter - Fix any style issues
PR checklist
- Tests added/updated
- Documentation updated
- Linter passes
- All tests pass
- Commit messages are clear
Commit messages
Use clear, descriptive commit messages:feat:- New featurefix:- Bug fixdocs:- Documentation changestest:- Test changesrefactor:- Code refactoringchore:- Maintenance tasks
Issue templates
Bug report
Feature request
Code of conduct
- Be respectful and inclusive
- Provide constructive feedback
- Focus on the code, not the person
- Help others learn and grow
Getting help
- Discord - Join our Discord server for real-time help
- GitHub Issues - Report bugs or request features
- Discussions - Ask questions and share ideas