# IntelliJ Plugin Template

![official JetBrains project](https://jb.gg/badges/official-flat-square.svg)
![Tests](https://github.com/hsz/intellij-plugin-template/workflows/Tests/badge.svg)

IntelliJ Plugin Template is a repository that provides a pure boilerplate for creating a plugin project with ease
designed as a GitHub template repository (check the [Creating a repository from a template][gh-template] article).
The main goal for this Template is to speed up the setup phase of the plugin development for the new as well as existing
developers by preconfiguring the project scaffold, CI and linking to the proper documentation pages as well as keeping
everything in the most straightforward manner.

We can detail here the following parts:

- Gradle configuration
- Sample code:
  - listeners - project and dynamic plugin lifecycle
  - services - project- and application-related services 
  - actions - basic action with shortcut binding
- Plugin Manifest file
- README Template
- CI based on GitHub actions
- Release and changelog maintenance flow

## Getting started

TODO

## Gradle

TODO

## Sample Code

TODO

## Plugin Manifest File

TODO

## Continuous Integration

TODO

## Release Flow

### Changelog

When delivering a new release, it is important to let your audience know what is the updated version offering.
The best way of handling that is to attach the changelog.

Changelog is a curated list containing information of any new features, fixes, deprecations, and so on.
If provided, such list would be available in a couple of places: [CHANGELOG.md](./CHANGELOG.md) file,
[Releases page][releases], [What's new][marketplace-plugin-page] section in Marketplace's Plugin page
and inside of the Plugin Manager's item details. 

There many different methods of handling the project's changelog. One of them, used in the current template project,
is the [Keep a Changelog][keep-a-changelog] approach.

## Useful Links

- [IntelliJ Platform SDK DevGuide][sdk-docs]
- [IntelliJ SDK Code Samples][code-samples]
- [JetBrains Platform Slack][slack]
- [IntelliJ IDEA Open API and Plugin Development][forum]
- [Keep a Changelog][keep-a-changelog]
- [GitHub Actions][gh-actions]

[gh-template]: https://help.github.com/en/enterprise/2.20/user/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template
[gh-actions]: https://help.github.com/en/actions
[sdk-docs]: https://www.jetbrains.org/intellij/sdk/docs
[code-samples]: https://github.com/JetBrains/intellij-sdk-code-samples
[releases]: https://github.com/JetBrains/intellij-plugin-template/releases
[slack]: https://plugins.jetbrains.com/slack
[forum]: https://intellij-support.jetbrains.com/hc/en-us/community/topics/200366979-IntelliJ-IDEA-Open-API-and-Plugin-Development
[keep-a-changelog]: https://keepachangelog.com