Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 2.09 KB

contributing.md

File metadata and controls

46 lines (33 loc) · 2.09 KB
Raw

What this repository is

This repository contains sources of the Introduction to IDE Code Refactoring in Kotlin course.

Contributing

We love contributions! We are happy to see fixes of the existing bugs and tasks and tests mistakes. The current tasks can be found in the open issues in the project. If you have some questions or find bugs or mistakes, please do not hesitate to open new ones.

Please, add a comment to the issue, if you're starting work on it.

If you add some common functionality, e.g. for the test system, it is important to add comments to describe new behaviour. This will help other developers and users to use them correctly.

Submitting patches

The best way to submit a patch is to fork the project on GitHub and then send us a pull request to the main branch via GitHub.

If you create your own fork, it might help to enable rebase by default when you pull by executing

git config --global pull.rebase true

This will avoid your local repo having too many merge commits which will help keep your pull request simple and easy to apply.

Search and fix formatting issues

We use the Detekt tool as the main static analysis tool. To build the projects with Detekt you need to run the build task with -PrunDetekt property.

Checklist

Before submitting the pull request, make sure that you can say "YES" to each point in this short checklist:

  • You provided the link to the related issue(s) from the repository;
  • You made a reasonable amount of changes related only to the provided issues;
  • You can explain changes made in the pull request;
  • You ran the build locally and verified new functionality/fixed bugs;
  • You ran related tests locally (or add new ones) and they passed;
  • You don't have code-style problems according the GitHub Actions
  • You do not have merge conflicts in the pull request.