Skip to content

Latest commit

 

History

History
50 lines (30 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

50 lines (30 loc) · 2.43 KB
Raw

Contributing to PuhKit App

Thank you for considering contributing to PuhKit! We welcome your contributions to make this app even better. Before you start, please take a moment to read the following guidelines.

Code of Conduct

Please review our Code of Conduct to understand our community standards and expectations.

Reporting Issues

If you encounter a bug or have a feature request, please open an issue on our GitHub Issues page. When reporting issues, please provide as much detail as possible, including the steps to reproduce the issue and the version of the app you are using.

Pull Requests

We welcome contributions in the form of pull requests (PRs). If you'd like to contribute code, please follow these steps:

  1. Fork the repository to your GitHub account.
  2. Create a new branch for your feature or bug fix: git checkout -b feature-or-bug-fix.
  3. Make your changes and ensure that the code follows our coding standards.
  4. Test your changes thoroughly to ensure they work as expected.
  5. Commit your changes with a clear and concise commit message.
  6. Push your changes to your fork: git push origin feature-or-bug-fix.
  7. Create a pull request (PR) from your fork to the main branch of the original repository.

Coding Standards

Please follow these coding standards when contributing to PuhKit:

  • Use consistent code formatting and indentation.
  • Write clear and concise code with meaningful variable and function names.
  • Include comments when necessary to explain complex logic or functionality.
  • Keep the codebase clean and remove any unnecessary or commented-out code.

Testing

If you are adding new features or fixing bugs, please include relevant unit tests to ensure that your changes do not introduce regressions. Run the existing tests using flutter test to ensure that your changes do not break existing functionality.

Documentation

If your contribution includes changes to user-facing features or behavior, please update the relevant documentation in the README.md file.

Code Reviews

All contributions will be reviewed by project maintainers. Be prepared to address feedback and make necessary revisions to your code.

License

By contributing to this project, you agree to license your code under the MIT License.

Thank you for your contributions to PuhKit! We appreciate your help in making this app a great tool for users.