Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

51 lines (31 loc) · 2.77 KB
Raw

Contributing to "Jenkins Development Support" for IntelliJ IDEA

Thank you for considering contributing to the project! In the Jenkins project we appreciate any kind of contributions: code, documentation, design, etc. Any contribution counts, and the size does not matter! Check out this page for more information and links!

Providing feedback

  • Never report security issues on GitHub, public Jira issues or other public channels (Gitter/Twitter/etc.), follow the instruction from Jenkins Security to report it on Jenkins Jira
  • For anything else please use GitHub Issues

ℹ️ Note, that issue templates are inherited from the organization. Bug report requests too many details regarding Jenkins which are irrelevant for the plugin. Please disregard and instead open "About IntelliJ" and use "Copy" button. (Override organization issue templates for this repository)

Source code contribution ways of working

  • For larger contributions create an issue for any required discussion
  • Implement solution on a branch in your fork
  • Make sure to include issue ID (if created) in commit message, and make the message speak for itself
  • Once you're done create a pull request and ask at least one of the maintainers for review
    • Remember to title your pull request properly as it is used for release notes

Things to learn before code contribution

Landing page for IntelliJ plugin developers is JetBrains Platform.

The most relevant information for development of this plugin is in IntelliJ Platform Plugin SDK.

Find plugin implementation examples on IntelliJ Platform Explorer.

IntelliJ IDEA has a hidden tooling for plugin developers. See Internal Actions Menu

How to Run Locally

Prerequisites

JDK 11 is the only pre-requisite.

Run ./gradlew buildPlugin or gradlew.bat buildPlugin to get Gradle and all the necessary dependencies

CLI

./gradlew runIde will start IDEA version specified in gradle.properties with plugin installed

IntelliJ IDEA

  1. Create new project from existing source using Gradle project
  2. Use one of the persisted "runIde" Run/Debug configurations to start IDEA based on gradle.properties or a specific version

https://github.com/jenkinsci/design-library-plugin is a good small project for manual testing since it demonstrates various Stapler and Jelly features.