Contributing to AurisLink

Learn about the contribution policy and how to contribute to AurisLink.

Important: Contribution Policy

Only the `dev` branch accepts pull requests. Any contributions submitted to other branches (such as `v1` or `main`) will be automatically rejected.

This ensures that all contributions are properly reviewed and tested before being merged into stable releases.

Branch Policy

dev

✅ ACCEPTS PULL REQUESTS

The development branch where all new features, bug fixes, and improvements are merged. This is the only branch that accepts contributions.

Submit PRs here: git push origin feature/your-feature -u

v1

❌ DOES NOT ACCEPT PULL REQUESTS

The stable release branch. Any PRs submitted to this branch will be rejected. Use this branch only for production deployments.

main

❌ DOES NOT ACCEPT PULL REQUESTS

Mirror of the latest stable release. Any PRs submitted to this branch will be rejected.

Other Branches

❌ DOES NOT ACCEPT PULL REQUESTS

Any other branches are experimental or temporary. PRs to these branches will be rejected.

How to Contribute

1

Fork the Repository

Click the "Fork" button on GitHub to create your own copy of the repository.

Fork on GitHub →
2

Clone and Create Branch

git clone https://github.com/YOUR_USERNAME/aurislink.git
cd aurislink
git checkout dev
git checkout -b feature/your-feature-name

Always branch from dev, not from other branches.

3

Make Your Changes

  • • Follow the existing code style
  • • Write clear, descriptive commit messages
  • • Test your changes thoroughly
  • • Update documentation if needed
4

Push and Create Pull Request

git add .
git commit -m "feat: describe your changes"
git push origin feature/your-feature-name

Then open a pull request on GitHub targeting the dev branch.

View Pull Requests →
5

Wait for Review

Your PR will be reviewed by the maintainers. They may request changes or ask questions. Once approved, your changes will be merged into the dev branch.

What Will Be Rejected

  • ✗Pull requests to the v1 branch
  • ✗Pull requests to the main branch
  • ✗Pull requests to any branch other than dev
  • ✗PRs that don't follow the code style or guidelines
  • ✗PRs without clear descriptions or commit messages

Questions?

If you have questions about contributing, feel free to:

Thank you for your interest in contributing to AurisLink! 🎉

← Back to Documentation