Skip to content

Latest commit

 

History

History
44 lines (37 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

44 lines (37 loc) · 2.18 KB
Raw

Contributing to Kotlin Js Preview

First off, thank you for considering contributing to Kotlin Js Preview! It's people like you that make Kotlin Js Preview such a great tool.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. Issues
  4. Pull Requests
  5. Getting Help
  6. Coding Guidelines
  7. How Can I Contribute?

Code of Conduct

There is a Code of Conduct in place which is expected to be upheld by everyone participating in this project. Please read CODE_OF_CONDUCT.md before engaging with our community.

Getting Started

  1. Fork this repository to your own account
  2. Make your changes
  3. Run detekt with detektAll gradle task
  4. After all analyzers passing commit your work and push to a new branch on your fork
  5. Submit a pull request
  6. Participate in the code review process by responding to feedback

Issues

  • Do use the search feature to check if a similar issue already exists.
  • Do ensure the bug was not already reported before creating a new one.
  • Do ask questions or for help on the mailing list (if applicable) before logging an issue.
  • Don't use the issue tracker for personal support requests.

Pull Requests

  • Do include relevant unit tests when submitting code.
  • Do ensure your code passes all tests before submitting a PR.
  • Do provide a detailed description of the changes in your PR.
  • Don't submit a PR without first creating an issue and discussing it with the maintainers.

Getting Help

How Can I Contribute?

  1. Reporting Bugs: If you find a bug, please first check the issue tracker to see if it has already been reported. If not, create a new issue.
  2. Suggesting Enhancements: If there's a feature or enhancement you'd like to see, first check the issue tracker to see if it was already proposed. If not, create a new issue.
  3. Code Contributions: If you'd like to contribute code (bug fixes or features), please first discuss it with us on the issue tracker. Once it is agreed on the approach, you can send in your pull request.