Skip to main content

Getting started

We welcome contributions to Sorionlib! This guide will help you get started.

Repository structure

Setting up locally

  1. Fork the repository Click the “Fork” button on GitHub.
  2. Clone your fork
  3. Install dependencies
  4. Create a branch
  5. 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/await instead 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

  1. Update tests - Add or update tests for your changes
  2. Update documentation - Document new features or changes
  3. Run the test suite - Ensure all tests pass
  4. 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:
Prefixes:
  • feat: - New feature
  • fix: - Bug fix
  • docs: - Documentation changes
  • test: - Test changes
  • refactor: - Code refactoring
  • chore: - 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
Thank you for contributing to Sorionlib!