From 38a35dcfd62eb3d33abeb07388428d8fae25b59e Mon Sep 17 00:00:00 2001 From: sebthom Date: Sun, 25 Aug 2024 19:33:10 +0200 Subject: [PATCH] docs: update README Signed-off-by: sebthom --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e21586d3b..8172e5a2f 100644 --- a/README.md +++ b/README.md @@ -9,25 +9,29 @@ If you like/use this project, a Star / Watch / Follow on GitHub is appreciated. ## How to use this -[See theses slides here](http://www.slideshare.net/mikervorburger/the-end-of-the-world-as-we-know-it-aka-your-last-nullpointerexception-1b-bugs) from this [EclipseCon Europe 2016 presentation](https://www.eclipsecon.org/europe2016/session/end-world-we-know-it-aka-your-last-nullpointerexception-1b-bugs) for some background about this project. +[See theses slides here](http://www.slideshare.net/mikervorburger/the-end-of-the-world-as-we-know-it-aka-your-last-nullpointerexception-1b-bugs) from this +[EclipseCon Europe 2016 presentation](https://www.eclipsecon.org/europe2016/session/end-world-we-know-it-aka-your-last-nullpointerexception-1b-bugs) for some background about this project. -To automatically Enable Annotation-based Null Analysis in the Eclipse Project Preferences correctly (e.g. when you import the `examples/` here), we highly recommend you install the [eclipse-external-annotations-m2e-plugin](https://github.com/lastnpe/eclipse-external-annotations-m2e-plugin) Maven IDE (M2E) Configurator Eclipse plugin. (On Eclipse m2e versions < 1.8 (shipped with Oxygen), you also had to install [m2e-jdt-compiler](https://github.com/jbosstools/m2e-jdt-compiler), but with M2E 1.8 in Oxygen that is not necessary anymore, even harmful; see below.) +To automatically Enable Annotation-based Null Analysis in the Eclipse Project Preferences correctly (e.g. when you import the `examples/` here), we highly +recommend you install the [eclipse-external-annotations-m2e-plugin](https://github.com/lastnpe/eclipse-external-annotations-m2e-plugin) Maven IDE (M2E) Configurator Eclipse plugin. +(On Eclipse m2e versions < 1.8 (shipped with Oxygen), you also had to install [m2e-jdt-compiler](https://github.com/jbosstools/m2e-jdt-compiler), but with M2E 1.8 in Oxygen that is not necessary anymore, even harmful; see below.) ## Contribute -This project aims to develop an active community of contributors, and not remain controlled by a single person. Anyone making 3 intelligent contributions to this repo may ask to be promoted from a contributor to a committer with full write access by opening an issue requesting it. (We reserve the right to re-remove committers in exceptional circumstances, and after long periods of inactivity.) +This project aims to develop an active community of contributors, and not remain controlled by a single person. +Anyone making 3 intelligent contributions to this repo may ask to be promoted from a contributor to a committer with full write access by opening an issue requesting it. +(We reserve the right to remove committers in exceptional circumstances, and after long periods of inactivity.) -We intend to liberally and quickly merge any contributions with additions to EEA, and avoid delays due to lengthy reviews -(which are anyway [kind of difficult to do rapidly and at scale until we solve issue #16](https://github.com/lastnpe/eclipse-null-eea-augments/issues/16)), +We intend to liberally and quickly merge any contributions with additions to EEA, and avoid delays due to lengthy reviews +(which are anyway [kind of difficult to do rapidly and at scale until we solve issue #16](https://github.com/lastnpe/eclipse-null-eea-augments/issues/16)), based on the idea that having an EEA that can be tested is better than none. -We intend to spend more time and request community feedback from engaged previous contributors on any proposed changes to existing EEA in this repo. When making contributions with changes, please explain what is wrong in the current version in the commit message. +We intend to spend more time and request community feedback from engaged previous contributors on any proposed changes to existing EEA in this repo. +When making contributions with changes, please explain what is wrong in the current version in the commit message. We generally do not "self merge", but let other committers merge our own changes. -We hang out and chat about this project on https://mattermost.eclipse.org/eclipse/channels/jdt-null-analysis - ## Troubleshooting @@ -38,4 +42,4 @@ We hang out and chat about this project on https://mattermost.eclipse.org/eclips ## Future -If this is found to be of general interest, perhaps this could move to eclipse.org. If this happens, it would be imperative to keep it very easy for anyone to contribute via Pull Requests on GitHub (and not, or not you only, eclipse.org Gerrit changes). +If this is found to be of general interest, perhaps this could move to eclipse.org. If this happens, it would be imperative to keep it very easy for anyone to contribute via Pull Requests on GitHub (and not, or not you only, eclipse.org Gerrit changes).