Skip to main content

​
Contributing

Contribute improvements back to the OpenSync project.

​
Ways to Contribute

Bug Reports

Report issues on GitHub

Feature Requests

Suggest new features

Pull Requests

Submit code changes

Documentation

Improve the docs

​
Bug Reports

  1. Check existing issues first
  2. Create a new issue with:
    • Clear description
    • Steps to reproduce
    • Expected vs actual behavior
    • Environment details

​
Feature Requests

Open an issue with:
  • Use case description
  • Proposed solution
  • Alternatives considered

​
Pull Requests

1

Fork the repository

Create your own fork on GitHub.
2

Create a branch

bash git checkout -b feature/your-feature
3

Make changes

Follow the coding style and add tests if applicable.
4

Commit

Use clear, descriptive commit messages.
5

Push and create PR

bash git push origin feature/your-feature Then open a pull request on GitHub.

​
Development Guidelines

​
Code Style

  • TypeScript with strict mode
  • Prettier for formatting
  • ESLint for linting

​
Commits

Follow conventional commits: 
feat: add new feature
fix: resolve bug
docs: update documentation
refactor: improve code structure

​
Testing

Run tests before submitting: 
npm run test

​
Code of Conduct

Be respectful and constructive. See CODE_OF_CONDUCT.md for details.

​
Getting Help

  • Discussions - Ask questions in GitHub Discussions
  • Issues - Report bugs and request features
  • Discord - Join the community (if available)
Look for issues labeled “good first issue” to get started.