Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 2.18 KB
Raw

Contribution Guidelines

Thank you for considering contributing to our project! We appreciate your time and effort in helping us improve. To ensure a smooth and collaborative experience, please follow these guidelines when contributing.

Getting Started

  1. Fork the repository to your own GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your contribution: git checkout -b feature/your-feature-name.

Making Contributions

Coding Standards

  • Follow the existing code style and conventions for Kotlin code.
  • Write clear and concise code.
  • Include comments as necessary to explain your changes.
  • Ensure your code is well-documented if it introduces new functionality.
  • Test your changes thoroughly to ensure they work as expected in Kotlin code.

Commit Messages

  • Use descriptive commit messages that explain the purpose and scope of your changes.
  • Reference any related issues or pull requests in your commit message using the format: Fixes #issueNumber or Closes #issueNumber.

Testing

  • Test your changes thoroughly to ensure they work as expected in Kotlin code.
  • Include Kotlin-specific tests if applicable, and verify their functionality.
  • Include unit tests, if applicable, and make sure they pass.
  • If your changes impact existing functionality, update or add new tests accordingly.

Submitting Your Contribution

  1. Push your changes to your forked repository: git push origin feature/your-feature-name.
  2. Create a pull request (PR) from your fork to the main repository.
  3. Provide a clear and descriptive title and description for your PR.
  4. Reference any relevant issues or PRs in your description.
  5. Our team will review your PR as soon as possible. Please be patient during the review process.
  6. Make any requested changes or updates to your PR if needed.

Code of Conduct

Please note that this project has a Code of Conduct. We expect all contributors to adhere to it in all interactions within the project.

License

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

Thank you for contributing to our project! 🚀