Skip to content
This repository has been archived by the owner on May 4, 2023. It is now read-only.

Latest commit

 

History

History
55 lines (40 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

55 lines (40 loc) · 2.26 KB

Contributing

Issues

If you find a bug, please report it in the GitHub issue tracker.

Pull Requests

If you would like to contribute to the plugin, please send a Pull Request on GitHub. The Pull Request will be analyzed by Code Inspector and reviewed by a Codiga engineer.

DOs and DON'Ts

DO:

  • Follow our coding style
  • Add labels to your issues and pull requests (at least one label for each of Status/Type/Priority).
  • Give priority to the current style of the project or file you're changing, even if it diverges from the general guidelines.
  • Include tests when adding new features as much as possible. When fixing bugs, start with adding a test that highlights how the current behavior is broken.
  • Keep the discussions focused. When a new or related topic comes up, it's often better to create a new issue than to side track the discussion.
  • Run all Gradle verification tasks (./gradlew check) and test your code before submitting a pull request.

DON'T:

  • Send PRs for style changes.
  • Send big PRs. Instead, file an issue and start a discussion so that we can agree on a direction before you invest a large amount of time.
  • Commit code that you didn't write. If you find code that you think is a good fit, file an issue and start a discussion before proceeding.
  • Submit PRs that alter licensing related files or headers. If you believe there's a problem with them, file an issue and we'll be happy to discuss it.

Code Style

We follow the Google Java Code Style. We sometimes derive from it and that's okay.

Publish new version

  1. Update the version number in gradle.properties (see properties pluginVersion)
  2. Push the code with the new version number
  3. Wait for the GitHub Actions to be finished about your new push
  4. Go on GitHub and a new release with the new version number should be here. The GitHub tag must match the version tag in gradle.properties
  5. Publish the draft release

Relevant documentation