chylex/IntelliJ-IdeaVim
1
0
Fork 0
mirror of https://github.com/chylex/IntelliJ-IdeaVim.git synced 2024-10-19 13:42:45 +02:00
Code
0.53
IntelliJ-IdeaVim/CONTRIBUTING.md
Alex Plate 1326e8470a
Update docs of IdeaVim
2019-07-17 15:39:20 +03:00

4.2 KiB
Raw Permalink Blame History

2018.3 Tests
2019.1 Tests

Where to Start

In order to contribute to IdeaVim, you should have some understanding of Java or Kotlin.

See also these docs on the IntelliJ API:

You can start by:

  • Picking relatively simple tasks that are tagged with #patch_welcome in the issue tracker.
  • Read about the @VimBehaviorDiffers annotation and fix the corresponding functionality.

Development Environment

  1. Fork IdeaVim on GitHub and clone the repository on your local machine.

  2. Import the project from the existing sources in IntelliJ IDEA 2018.1 or newer (Community or Ultimate), by selecting "File | New | Project from Existing Sources..." or selecting "Import Project" from the Welcome screen.

    • In the project wizard, select "Import project from external model | Gradle".

    • Select your Java 8+ JDK as the Gradle JVM; leave other parameters unchanged.

  3. Run your IdeaVim plugin within IntelliJ via a Gradle task:

    • Select the "View | Tool Windows | Gradle" tool window.

    • Launch "ideavim | intellij | runIde" from the tool window.

  4. Run IdeaVim tests via a Gradle task:

    • Select the "View | Tool Windows | Gradle" tool window.

    • Launch "ideavim | verification | test" from the tool window.

  5. Build the plugin distribution by running ./gradlew clean buildPlugin in the terminal in your project root.

    • The resulting distribution file will be located at build/distributions/IdeaVim-VERSION.zip

    • You can install this file by selecting "Settings | Plugins | Install plugin from disk...".

Copyright

  1. Go to Preferences | Appearance & Behavior | Scopes, press "+" button, Shared.
    Name: Copyright scope
    Pattern: file[IdeaVIM.main]:com//*||file[IdeaVIM.test]:*/

  2. Go to Preferences | Editor | Copyright | Copyright Profiles and click the "+" button.
    Name: IdeaVim
    Text:

    IdeaVim - Vim emulator for IDEs based on the IntelliJ platform
Copyright (C) 2003-$today.year The IdeaVim authors

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

  3. Go to Preferences | Editor | Copyright, click the "+" button.
    Scope: Copyright scope
    Copyright: IdeaVim

Testing

  1. Read about the @VimBehaviorDiffers annotation.

  2. Please avoid senseless text like "dhjkwaldjwa", "asdasdasd", "123 123 123 123", etc. Try to choose an example text that is easy to read and understand what is wrong if the test fails. For example, take a few lines from your favorite poem, or use "Vladimir Nabokov – A Discovery" if you don't have one.

  3. Test your functionality properly. Especially check whether your command works with: line start, line end, file start, file end, empty line, multiple carets, dollar motion, etc.