Contribution Guide

Thank you for your interest in contributing to this project! We appreciate your efforts to make this project better. Please follow the guidelines below to ensure a smooth contribution process.

Guidelines

Code Contributions

Follow the existing code style and conventions.
Write meaningful PR titles.
Ensure your changes do not break existing functionality.
Run tests before submitting a pull request (PR).
Build and run your changes in your own environment to ensure they work as expected.
Add or update documentation if necessary.

Submitting a Pull Request

Ensure your branch is up to date with the main branch:

git fetch upstream
git checkout main
git merge upstream/main

Push your changes to your fork:
```
git push origin feature-branch-name
```
Open a PR on StackitGit, describing your changes clearly.
If your PR is related to an issue, use the StackitGit key words. This will ensure that the related issue will automatically close when your change is merged.
Address any feedback and update your PR as necessary.

Issue Reporting

Check for existing issues before opening a new one.
Provide clear, concise descriptions with steps to reproduce.
Include logs, screenshots, or example code if relevant.
Suggest possible solutions if applicable.

License

By contributing, you agree that your contributions will be licensed under the project's LICENSE.

Thank you for contributing!

1.6 KiB Raw Permalink Blame History