Contributing to xlf-sync

January 29, 2026 · View on GitHub

Thank you for your interest in contributing to xlf-sync! 🎉

We welcome contributions from the community, whether it's bug reports, feature requests, documentation improvements, or code contributions.

🌟 How to Contribute

1. Star the Repository

If you find this project useful, please consider giving it a ⭐ on GitHub. It helps others discover the project!

2. Report Bugs

Found a bug? Please open an issue with:

  • A clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Your environment (OS, Node version, Angular version)

3. Suggest Features

Have an idea for a new feature? Open an issue with:

  • A clear description of the feature
  • Use cases and benefits
  • Any implementation ideas (optional)

4. Submit Pull Requests

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/xlf-sync.git
  3. Create a new branch: git checkout -b feature/your-feature-name
  4. Install dependencies: npm install
  5. Make your changes
  6. Build the project: npm run build
  7. Test your changes: npm test
  8. Commit your changes: git commit -m "feat: add your feature"
  9. Push to your fork: git push origin feature/your-feature-name
  10. Open a Pull Request

Commit Message Convention

We follow Conventional Commits:

  • feat: - New features
  • fix: - Bug fixes
  • docs: - Documentation changes
  • refactor: - Code refactoring
  • test: - Test additions or updates
  • chore: - Maintenance tasks

Code Style

  • Use TypeScript
  • Follow existing code formatting
  • Add tests for new features
  • Update documentation as needed

🧪 Development Workflow

# Install dependencies
npm install

# Build the project
npm run build

# Run tests
npm test

# Watch mode for tests
npm run test:watch

# Test locally
node dist/cli.js --help

📝 Documentation

When adding new features, please update:

  • README.md - User-facing documentation
  • Code comments - For complex logic
  • Type definitions - Keep TypeScript types accurate

🤝 Code of Conduct

Be respectful and constructive in all interactions. We're here to build something great together!

📄 License

By contributing, you agree that your contributions will be licensed under the MIT License.

💬 Questions?

Feel free to open an issue or reach out to Anastasios Theodosiou.

Thank you for contributing! 🚀