Welcome to KouraLink! We appreciate your interest in contributing. Before you get started, please take a moment to review the following guidelines.
We follow the Gitflow branching model:
- master: Represents the latest stable release. Only accepts pull requests from the
release
branch. - develop: Represents the latest development changes. Only accepts pull requests from feature branches.
- feature branches: Start new features or improvements from the
develop
branch.
- Fork the repository and create a new branch from
develop
for your contribution.
git checkout -b feature/your-feature-name develop
- Make your changes, commit, and push to your fork.
git commit -m "Your descriptive commit message"
git push origin feature/your-feature-name
-
Submit a pull request to the develop branch of the main repository.
- Clearly describe the changes and the purpose of your pull request.
- Reference any related issues.
- Follow our coding standards and conventions.
- Include tests for new features or bug fixes.
- Update documentation when necessary.
- Ensure that your changes do not introduce breaking changes.
If you have any questions or need support, feel free to reach out to us on Discussions or via email at [email protected].
Thank you for contributing to KouraLink!