Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

44 lines (29 loc) · 1.77 KB

Contributing to Durian

Pull requests are welcome, preferably against master.

Build instructions

It's a bog-standard gradle build.

gradlew eclipse

  • creates an Eclipse project file for you.

gradlew build

  • builds the jar
  • runs FindBugs
  • checks the formatting
  • runs the tests

If you're getting style warnings, gradlew spotlessApply will apply anything necessary to fix formatting. For more info on the formatter, check out spotless.

Known problems

On OS X, SWT must be started with the -XstartOnFirstThread flag. The gradle test runner doesn't support this. This only affects testing from the command line, testing from the IDE is still just fine. There is a workaround by calling out to ant, but it's not friendly to our requirement to include @Category(InteractiveTest.class) and exclude @Category(FailsWithoutUser.class).

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

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

Copyright 2020 DiffPlug

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.