Skip to content

Commit

Permalink
Update primary branch to main.
Browse files Browse the repository at this point in the history
  • Loading branch information
nedtwigg committed Jun 15, 2020
1 parent a5849dd commit 1b09ca0
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to Goomph

Pull requests are welcome, preferably against `master`.
Pull requests are welcome, preferably against `main`.

## Build instructions

Expand Down Expand Up @@ -42,7 +42,7 @@ To test your changes, run `gradlew publishToMavenLocal` on your Goomph project.

## License

By contributing your code, you agree to license your contribution under the terms of the APLv2: https://github.com/diffplug/durian/blob/master/LICENSE
By contributing your code, you agree to license your contribution under the terms of the APLv2: https://github.com/diffplug/durian/blob/main/LICENSE

All files are released with the Apache 2.0 license as such:

Expand Down
18 changes: 9 additions & 9 deletions HOW_TO_AUTOMATE_IDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ output = prefixDelimiterReplace(input, 'https://javadoc.io/static/com.diffplug.g

So you want to automate your IDE configuration. The first thing to do is look at a few examples.

- [Gradle and Eclipse RCP talk](https://github.com/diffplug/gradle_and_eclipse_rcp/blob/master/ide/build.gradle) (multi-project Eclipse RCP project)
- [lsp4j](https://github.com/eclipse/lsp4j/blob/master/ide/build.gradle) (xtend IDE example)
- [swt-chromium](https://github.com/diffplug/swt-chromium/blob/master/ide/build.gradle) (C++ example)
- [Spotless](https://github.com/diffplug/spotless/blob/master/ide/build.gradle) (single-project Gradle plugin)
- [Gradle and Eclipse RCP talk](https://github.com/diffplug/gradle_and_eclipse_rcp/blob/main/ide/build.gradle) (multi-project Eclipse RCP project)
- [lsp4j](https://github.com/eclipse/lsp4j/blob/main/ide/build.gradle) (xtend IDE example)
- [swt-chromium](https://github.com/diffplug/swt-chromium/blob/main/ide/build.gradle) (C++ example)
- [Spotless](https://github.com/diffplug/spotless/blob/main/ide/build.gradle) (single-project Gradle plugin)
- (your example here)

The next thing is to look at the [javadoc](https://javadoc.io/static/com.diffplug.gradle/goomph/3.22.0/com/diffplug/gradle/oomph/OomphIdePlugin.html) for `OomphIdePlugin`, which inclues a pretty in-depth look at how it works.
Expand Down Expand Up @@ -76,15 +76,15 @@ You can also use Eclipse's internal APIs to programatically set properties. Thi

## How do I add a DSL for a plugin?

If you have an Eclipse plugin that you'd like to add to to Goomph, we'd love to have it! Take a look at [ConventionThirdParty](https://github.com/diffplug/goomph/blob/master/src/main/java/com/diffplug/gradle/oomph/thirdparty/ConventionThirdParty.java), and add a block for your plugin there. If you look at all subclasses of `OomphConvention`, you can see how you can make a configuration DSL for your users, if you'd like. But even just a simple "add the repo, add the feature" is helpful.
If you have an Eclipse plugin that you'd like to add to to Goomph, we'd love to have it! Take a look at [ConventionThirdParty](https://github.com/diffplug/goomph/blob/main/src/main/java/com/diffplug/gradle/oomph/thirdparty/ConventionThirdParty.java), and add a block for your plugin there. If you look at all subclasses of `OomphConvention`, you can see how you can make a configuration DSL for your users, if you'd like. But even just a simple "add the repo, add the feature" is helpful.

## Contribute back!

If you find out how to set a useful setting, please consider contributing it back! Key places where it might make sense to contribute:

- [ConventionStyle](https://github.com/diffplug/goomph/blob/master/src/main/java/com/diffplug/gradle/oomph/ConventionStyle.java) is the `style{}` block in `oomphIde`.
- [ConventionJdt](https://github.com/diffplug/goomph/blob/master/src/main/java/com/diffplug/gradle/oomph/ConventionJdt.java) is the `jdt{}` block in `oomphIde`.
- [ConventionPde](https://github.com/diffplug/goomph/blob/master/src/main/java/com/diffplug/gradle/oomph/ConventionPde.java) is the `pde{}` block in `oomphIde`.
- or a new subclass of [OomphConvention](https://github.com/diffplug/goomph/blob/master/src/main/java/com/diffplug/gradle/oomph/OomphConvention.java) to create a new way of grouping settings.
- [ConventionStyle](https://github.com/diffplug/goomph/blob/main/src/main/java/com/diffplug/gradle/oomph/ConventionStyle.java) is the `style{}` block in `oomphIde`.
- [ConventionJdt](https://github.com/diffplug/goomph/blob/main/src/main/java/com/diffplug/gradle/oomph/ConventionJdt.java) is the `jdt{}` block in `oomphIde`.
- [ConventionPde](https://github.com/diffplug/goomph/blob/main/src/main/java/com/diffplug/gradle/oomph/ConventionPde.java) is the `pde{}` block in `oomphIde`.
- or a new subclass of [OomphConvention](https://github.com/diffplug/goomph/blob/main/src/main/java/com/diffplug/gradle/oomph/OomphConvention.java) to create a new way of grouping settings.

<!---freshmark /javadoc -->
2 changes: 1 addition & 1 deletion PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Please make sure that your [PR allows edits from maintainers](https://help.githu

![Allow edits from maintainers](https://help.github.com/assets/images/help/pull_requests/allow-maintainers-to-make-edits-sidebar-checkbox.png)

After creating the PR, please add a commit that adds a bullet-point under the `-SNAPSHOT` section of [CHANGES.md](https://github.com/diffplug/goomph/blob/master/CHANGES.md) that includes:
After creating the PR, please add a commit that adds a bullet-point under the `-SNAPSHOT` section of [CHANGES.md](https://github.com/diffplug/goomph/blob/main/CHANGES.md) that includes:

- [ ] a summary of the change
- [ ] a link to the newly created PR
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ output = [
link(shield('Changelog', 'changelog', '{{versionLast}}', 'brightgreen'), 'CHANGES.md'),
link(shield('Javadoc', 'javadoc', 'yes', 'brightgreen'), 'https://javadoc.io/doc/com.diffplug.gradle/goomph/{{versionLast}}/index.html'),
link(shield('Live chat', 'gitter', 'live chat', 'brightgreen'), 'https://gitter.im/diffplug/goomph'),
link(image('Travis CI', 'https://travis-ci.org/diffplug/goomph.svg?branch=master'), 'https://travis-ci.org/diffplug/goomph')
link(image('Travis CI', 'https://travis-ci.org/diffplug/goomph.svg?branch=main'), 'https://travis-ci.org/diffplug/goomph')
].join('\n');
-->
[![Gradle plugin](https://img.shields.io/badge/plugins.gradle.org-yes-blue.svg)](https://plugins.gradle.org/search?term=goomph)
Expand All @@ -20,7 +20,7 @@ output = [
[![Changelog](https://img.shields.io/badge/changelog-3.22.0-brightgreen.svg)](CHANGES.md)
[![Javadoc](https://img.shields.io/badge/javadoc-yes-brightgreen.svg)](https://javadoc.io/doc/com.diffplug.gradle/goomph/3.22.0/index.html)
[![Live chat](https://img.shields.io/badge/gitter-live_chat-brightgreen.svg)](https://gitter.im/diffplug/goomph)
[![Travis CI](https://travis-ci.org/diffplug/goomph.svg?branch=master)](https://travis-ci.org/diffplug/goomph)
[![Travis CI](https://travis-ci.org/diffplug/goomph.svg?branch=main)](https://travis-ci.org/diffplug/goomph)
<!---freshmark /shields -->

<!---freshmark javadoc
Expand Down

0 comments on commit 1b09ca0

Please sign in to comment.