Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

44 lines (29 loc) · 1.71 KB

Contributing to AtPlug

Pull requests are welcome, preferably against master.

Every successful Travis CI build on branch master is automatically published to https://oss.sonatype.org/content/repositories/snapshots, and its javadoc are published here.

Build instructions

The easiest way to work on Spotless is to run gradlew ide. It will download and setup an Eclipse IDE for you, using goomph.

Otherwise it's a bog-standard gradle build.

gradlew eclipse

  • creates Eclipse project files for you.

gradlew build

  • builds the jars
  • 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.

License

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

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

Copyright 2015 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

  http://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.