Skip to content

Commit 2fefd47

Browse files
committed
Updated README
1 parent 663b098 commit 2fefd47

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
1-
intellij-cucumber-scala
2-
=======================
1+
# intellij-cucumber-scala
32

43
![Build for intellij-cucumber-scala](https://github.com/vbmacher/intellij-cucumber-scala/workflows/Build%20for%20intellij-cucumber-scala/badge.svg)
54

65
Enables Reference tracking of glue code when using cucumber-scala DSL.
76

8-
# Features
7+
## Features
98

109
- [x] Navigate from feature step to step definition
1110
- [ ] Find usages of step definitions in feature files
1211
- [ ] Wizard that creates step definitions for a step in a feature file
1312

1413

15-
# Development
14+
## Development
1615

1716
1. `git clone https://github.com/vbmacher/intellij-cucumber-scala.git`
1817
2. `./gradlew` will download the idea sdk to the SDK folder and all required plugins
@@ -21,12 +20,20 @@ Enables Reference tracking of glue code when using cucumber-scala DSL.
2120
Now you can build this plugin with `./gradlew buildPlugin`.
2221

2322
To start an IDE with the plugin installed in the example project just run `./gradlew runIde`. Import the whole project as gradle project in the sandbox-ide. Wait for indexing to finish. Open `example/src/test/resources/cucumber/examples/scalacalculator/basic_arithmetic.feature`.
23+
24+
## Contributing
25+
26+
Anyone can contribute. The best is to pick up some issue tagged with `help_wanted`, or bringing new ideas by creating new issues.
27+
28+
Git branch `development` is used for developing upcoming version. When the plugin is to be released, the
29+
branch is merged into `master` branch, which is then used for the release. The release commit is tagged.
2430

25-
# Publishing
31+
## Publishing
32+
33+
A "publish token" must be set up in order to publish the plugin to [JetBrains plugins portal](https://plugins.jetbrains.com/plugin/7460-cucumber-for-scala). The token can be set up either by system variable or Gradle property named `PUBLISH_TOKEN` (e.g. put it in `gradle.properties` file, but do not commit it!).
2634

27-
1. Add your publish token to `publishPlugin.token` in `cucumber-scala/build.gradle` (make sure to not check them in!)
28-
2. run `./gradlew publishPlugin`
35+
Then, run `./gradlew publishPlugin`
2936

30-
# License
37+
## License
3138

3239
This project is released under the __Apache License, Version 2.0__ (http://www.apache.org/licenses/LICENSE-2.0).

0 commit comments

Comments
 (0)