44 lines
1.6 KiB
Markdown
44 lines
1.6 KiB
Markdown
# 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
|
|
1. Ensure your branch is up to date with the main branch:
|
|
|
|
```sh
|
|
git fetch upstream
|
|
git checkout main
|
|
git merge upstream/main
|
|
```
|
|
|
|
2. Push your changes to your fork:
|
|
|
|
```sh
|
|
git push origin feature-branch-name
|
|
```
|
|
|
|
3. Open a PR on StackitGit, describing your changes clearly.
|
|
4. If your PR is related to an issue, use the [StackitGit key words](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests#linking-a-pull-request-to-an-issue).
|
|
This will ensure that the related issue will automatically close when your change is merged.
|
|
5. 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](LICENSE).
|
|
|
|
Thank you for contributing!
|