From b351b2af2c3996d0cb9e4c6377b9bcd3789ff199 Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Tue, 13 Jun 2017 00:13:47 +0200 Subject: Added a ‘contributing’ page. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- website/templates/_scaffold.html | 2 +- website/templates/contributing.html | 35 +++++++++++++++++ website/templates/disable-checked-exceptions.html | 48 ++++++++++++----------- 3 files changed, 62 insertions(+), 23 deletions(-) create mode 100644 website/templates/contributing.html (limited to 'website/templates') diff --git a/website/templates/_scaffold.html b/website/templates/_scaffold.html index 8d639b69..1f4322eb 100644 --- a/website/templates/_scaffold.html +++ b/website/templates/_scaffold.html @@ -74,7 +74,7 @@ ga('send', 'pageview');
  • - + Contribute
    • diff --git a/website/templates/contributing.html b/website/templates/contributing.html new file mode 100644 index 00000000..574e3aa8 --- /dev/null +++ b/website/templates/contributing.html @@ -0,0 +1,35 @@ +<#import "/_scaffold.html" as main> + +<@main.scaffold> +
    +
    +

    How to work on Project Lombok yourself

    +
    + Project Lombok is being developed via the lombok git repository on github. +
    +

    + If you want to start development on lombok, clone the repository and run ant eclipse or ant intellij, then open the working directory as a project in eclipse / intellij. Because the main contributors of lombok all use eclipse, that'll probably work a little more smoothly. +

    + To produce a lombok jar, run ant dist; in general run ant -p; there's lots of stuff there, including downloading various versions of java runtimes to run the test suite against, and building this website. +

    +
    +

    Adding your own handlers and annotations to Lombok

    +
    +

    + If you want to extend lombok, we advise that you fork lombok and add handlers directly into the same place and package that lombok's handlers are in (lombok.javac.handlers and lombok.eclipse.handlers) – lombok does some fancy footwork to ensure various modular class loading systems don't interface with finding the lombok classes, but that system is not (currently) easily expanded to include separate jars. +

    +
    +

    Contributing to Project Lombok

    +
    +

    + To create new features and add them to project lombok itself, send us pull requests via github. However, before you start, discuss the feature or fix you'd like to contribute, preferably via the Project Lombok Forum. If you're going to add a new feature, make sure to post 2 snippets (one with the annotation, the other with what that would generate), similar to how the feature pages list 'with lombok' and 'without lombok' variants. +

    + We've considered many designs and features amongst ourselves and with the community, and often there are complications or interesting design choices that have already been mentioned. We'd like to share them with you before you set out. +

    + Pull requests for new features that haven't been discussed are unlikely to be accepted. Of course, if you've already built a proof of concept implementation prior to bringing a new idea to the forum, we'll take it that much more seriously. +

    + Happy coding! +

    +
    +
    + diff --git a/website/templates/disable-checked-exceptions.html b/website/templates/disable-checked-exceptions.html index 94dd433e..ccbd0c01 100644 --- a/website/templates/disable-checked-exceptions.html +++ b/website/templates/disable-checked-exceptions.html @@ -1,24 +1,28 @@ -
    -
    -

    Tired of checked exceptions?

    -
    -
    -

    - This lombok spinoff project consists of a hack that only works in javac - not eclipse or any other IDE.
    - It will completely disable the notion of checked exceptions. You may throw any exception anywhere, and you may also catch any exception anywhere. In standard javac, you may not catch a checked exception that is not declared as thrown by at least 1 statement in your try block, unless it is Exception or Throwable.
    - This restriction is lifted as well. -

    -
    -
    -

    Usage

    +<#import "/_scaffold.html" as main> -

    - Just make sure disableCheckedExceptions-alpha.jar is on the classpath as you compile. For example:
    - javac -cp disableCheckedExceptions-alpha.jar MySource.java -

    - Ready to try it out? download it here: disableCheckedExceptions-alpha.jar -

    - Want to know how its done? Grab the lombok repository here on github, and look in the experimental directory. -

    +<@main.scaffold> +
    +
    +

    Tired of checked exceptions?

    +
    +
    +

    + This lombok spinoff project consists of a hack that only works in javac - not eclipse or any other IDE.
    + It will completely disable the notion of checked exceptions. You may throw any exception anywhere, and you may also catch any exception anywhere. In standard javac, you may not catch a checked exception that is not declared as thrown by at least 1 statement in your try block, unless it is Exception or Throwable.
    + This restriction is lifted as well. +

    +
    +
    +

    Usage

    + +

    + Just make sure disableCheckedExceptions-alpha.jar is on the classpath as you compile. For example:
    + javac -cp disableCheckedExceptions-alpha.jar MySource.java +

    + Ready to try it out? download it here: disableCheckedExceptions-alpha.jar +

    + Want to know how its done? Grab the lombok repository here on github, and look in the experimental directory. +

    +
    -
    + -- cgit