Thank you for considering contributing to SyncLite! We welcome all kinds of contributions, including:
- Building open-source data integration projects on top of SyncLite platform demonstrating interesting usecases
- Reporting issues and bugs
- Adding new integration tests
- Fixing issues and bugs
- Submitting new features and improvements
- Reviewing pull requests
- Improving documentation
- Providing feedback and suggestions
- Fork the repository: Start by forking the repository to your GitHub account.
- Clone your fork: Clone the forked repository to your local machine.
git clone https://github.com/YOUR-USERNAME/SyncLite.git
- Create a new branch: Make a new branch for your feature or bug fix. Branches should be named following the convention:
For example, if you're working on issue #25, name your branch
issue#<issue-number>
issue#25
. - Make changes: Develop your feature, fix a bug, or improve documentation. Ensure the code adheres to the project's coding style.
- Test your changes: Run the integration tests in the synclite-validator tool to ensure your changes are correct and don't break existing functionality.
- Commit your changes: Write a meaningful commit message.
git commit -m "Brief description of your changes"
- Push your changes: Push your branch to GitHub.
git push origin issue#<issue-number>
- Create a pull request: Open a pull request from your forked repository and describe your changes. Please reference relevant issues if applicable.
When opening issues, please prefix the title with <project-name>:
e.g. synclite-validator: Add new integration test for SyncLite QReader
Be as descriptive as possible, including steps to reproduce the issue if applicable.
Please follow the common conventions used in Java projects. Refer : Google's Java Style Guide).
We expect contributors to follow our Code of Conduct when participating in the project.
By contributing, you agree that your contributions will be licensed under the Apache License 2.0.