CONTRIBUTING.md

Contribution Guidelines

Thank you for considering contributing to the Stadata Flutter SDK! Please follow these guidelines to contribute effectively.

Creating an Issue

• Before creating a pull request, consider opening an issue to discuss your proposed changes or enhancements.
• Use a descriptive title and provide detailed information about your issue or suggestion.
• Use the appropriate issue template (bug report, feature request, documentation, etc.) when creating an issue.

Pull Requests

• Before creating a pull request, make sure you have discussed the changes in an issue.
• Ensure your pull request is related to an open issue; reference the issue in your pull request description.
• Follow the coding standards and conventions used in the project.
• Include relevant test cases and documentation for your changes.
• Keep your pull request concise and focused.

Git Flow

• We use Git Flow as our branching model. Please ensure that your pull requests are based on the appropriate branch, such as develop or feature branches.
• Familiarize yourself with the Git Flow process: Git Flow Workflow.

Signed Commits

• We encourage the use of signed commits to enhance code integrity and traceability.
• Consider using GPG (GNU Privacy Guard) to sign your commits.
• You can learn how to sign commits in GitHub's documentation.

Issue Templates

We provide the following issue templates:

• Bug Report
• Build
• Chore
• CI
• Documentation
• Feature Request
• Performance
• Refactor
• Revert
• Style
• Test

Please use the appropriate template when creating an issue.

Code of Conduct

This project follows a Code of Conduct. Please be respectful and follow it at all times.

Questions and Discussions

If you have questions or need clarification about the contribution process, feel free to open a discussion in the GitHub Discussions section.

Thank you for contributing!