Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 350858

Summary: egit contributor guide seems outdated
Product: [Technology] EGit Reporter: Martin Oberhuber <mober.at+eclipse>
Component: CoreAssignee: Project Inbox <egit.core-inbox>
Status: CLOSED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: matthias.sohn
Version: unspecified   
Target Milestone: ---   
Hardware: All   
OS: All   
URL: http://wiki.eclipse.org/EGit/Contributor_Guide
Whiteboard:

Description Martin Oberhuber CLA 2011-06-30 11:49:37 EDT
I've tried following the egit contributor guide,
   http://wiki.eclipse.org/EGit/Contributor_Guide
which is excellent for the most part, but after importing projects most of my project tree is red due to errors...

- The guide doesn't tell me how to set an API Baseline or where to get it from,
  or how to disable the error

- It looks like following additional libs are needed from Orbit, these should
  be added to the list of libs from Orbit to install as well as the PSF, or
  would I get these by installing swtbot?
  - Hamcrest Library of Matchers (org.hamcrest)
  - Apache Log4J (org.apache.log4j)

- Getting individual libs from the Orbit Repo is awkward, why isn't the PSF
  good enough? Or would it make sense to leverage the new "P2 Import"
  feature?

- The guide is missing a hyperlink to see the project's Forum, Mailinglist or
  subscribe the mailinglist

- The guide is missing a hyperlink for filing a new bug

- Isn't Gerrit support for providing patches possible self-hosted as of 1.0?
Comment 1 Martin Oberhuber CLA 2011-06-30 12:46:39 EDT
Also, it took me ages to figure out where the "compute commit ID for Gerrit" option had gone... until I found that little button in the commit UI.

This should be mentioned in the contributor guide!
Comment 2 Matthias Sohn CLA 2011-07-01 03:09:47 EDT
(In reply to comment #0)
> I've tried following the egit contributor guide,
>    http://wiki.eclipse.org/EGit/Contributor_Guide
> which is excellent for the most part, but after importing projects most of my
> project tree is red due to errors...
> 
> - The guide doesn't tell me how to set an API Baseline or where to get it from,
>   or how to disable the error

nobody had the time yet to figure out how to set an API baseline, maybe you can help here ?
 
> - It looks like following additional libs are needed from Orbit, these should
>   be added to the list of libs from Orbit to install as well as the PSF, or
>   would I get these by installing swtbot?
>   - Hamcrest Library of Matchers (org.hamcrest)
>   - Apache Log4J (org.apache.log4j)

Yes, AFAIK you get them from swtbot installation which is anyway required. If you work on
EGit you should also run UI tests so you should install swtbot. Though it would
be nice to add a target platform project to the maven build which could download all
dependencies and create a self-contained target platform in a simple maven build. Had no time yet to look into that, but it's on my whishlist.

> 
> - Getting individual libs from the Orbit Repo is awkward, why isn't the PSF
>   good enough? Or would it make sense to leverage the new "P2 Import"
>   feature?

no idea what "P2 import" feature is

> - The guide is missing a hyperlink to see the project's Forum, Mailinglist or
>   subscribe the mailinglist
> - The guide is missing a hyperlink for filing a new bug

I added a section with these links

> - Isn't Gerrit support for providing patches possible self-hosted as of 1.0?

I don't understand this question
Comment 3 Matthias Sohn CLA 2011-08-03 18:57:44 EDT
I think this is done, if you need more updates please reopen