This Rug project contains an Atomist Rug archive project
a sample Rug TypeScript editor
Put your editor prerequisites here.
This Rug takes following parameters.
| Name | Required | Default | Description |
|---|---|---|---|
inputParameter |
Yes | Example input parameter |
Run this Rug as follows:
$ rug edit -C ../project/directory -l MyFirstEditor inputParameter='some value'
Explain what your editor does here.
General support questions should be discussed in the #support
channel on our community Slack team
at atomist-community.slack.com.
If you find a problem, please create an issue.
If you are interested in contributing to the Atomist open source projects, please see our contributing guidelines and our code of conduct.
You can build, test, and install the project locally with the Rug CLI.
$ ( cd .atomist && npm test )
$ rug install
To clean up cached files run:
$ ( cd .atomist && npm run clean )
To return this project to its distributed state run:
$ ( cd .atomist && npm run distclean )
You will need to install its dependencies again after this:
$ ( cd .atomist && npm install )
To create a new release of the project, simply push a tag of the form
M.N.P where M, N, and P are integers that form the next
appropriate semantic version for release. For example:
$ git tag -a 1.2.3
The Travis CI build (see badge at the top of this page) will automatically create a GitHub release using the tag name for the release and the comment provided on the annotated tag as the contents of the release notes. It will also automatically upload the needed artifacts.
Created by Atomist. Need Help? Join our Slack team.