Contributing to Vision AI Label Studio
Thank you for considering contributing to Vision AI Label Studio! We welcome contributions from the community to help improve and expand this project. Please follow the guidelines below to ensure a smooth contribution process.
🛠️ How to Contribute
1. Fork the Repository
- Navigate to the Vision AI Label Studio GitHub repository.
- Click the "Fork" button to create your own copy of the repository.
2. Clone Your Fork
# Clone your forked repository
git clone https://github.com/vailabel/vailabel-studio.git
# Navigate to the project directory
cd vailabel-studio
3. Create a Branch
Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-name
4. Make Changes
- Follow the existing code style and structure.
- Ensure your changes are well-documented and tested.
5. Commit Your Changes
git add .
git commit -m "Add a brief description of your changes"
6. Push Your Changes
git push origin feature/your-feature-name
7. Open a Pull Request
- Go to the original repository on GitHub.
- Click the "Pull Requests" tab and then "New Pull Request."
- Select your branch and submit your pull request.
📝 Guidelines
Code of Conduct
Please adhere to our Code of Conduct to ensure a welcoming environment for all contributors.
Commit Messages
- Use clear and concise commit messages.
- Follow the format:
type(scope): description(e.g.,feat(ui): add dark mode toggle).
Testing
- Ensure your changes do not break existing functionality.
- Add tests for new features or bug fixes.
Documentation
- Update the
README.mdor other relevant documentation files if your changes affect them.
🤝 Community
Join the Discussion
- Open an issue to discuss your ideas or report bugs.
- Engage with other contributors in the Discussions section.
Acknowledgements
We appreciate all contributions, big or small. Thank you for helping make Vision AI Label Studio better!
📄 License
By contributing, you agree that your contributions will be licensed under the GNU GENERAL PUBLIC LICENSE.