This Bugzilla instance is deprecated, and most Eclipse projects now use GitHub or Eclipse GitLab. Please see the deprecation plan for details.
Bug 421027 - Adding "how to contribute" to the Eclipse Platform ui README.md file
Summary: Adding "how to contribute" to the Eclipse Platform ui README.md file
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 4.3   Edit
Hardware: PC All
: P3 enhancement (vote)
Target Milestone: 4.4 M7   Edit
Assignee: Lars Vogel CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 420779
  Show dependency tree
 
Reported: 2013-11-04 18:15 EST by Lars Vogel CLA
Modified: 2014-04-22 08:55 EDT (History)
3 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Lars Vogel CLA 2013-11-04 18:15:47 EST 
Seems that the errors on the Eclipse UI project discourage people to look at them. Also the concept of the API Baseline is not widely adapted.

I suggest to add a README.md (Markdown file, which reads well the cgit webbrowser update planned for git.eclipse.org) for these plug-ins.

In general I think we should have README.md files for the plug-ins explaining their purpose. This is a good starting point to generated some.

I upload an example for org.eclipse.core.commands to Gerrit, if people agree on the approach I copy the README.md to all relevant plug-ins in the Eclipse UI repo.
Comment 1 Lars Vogel CLA 2013-11-04 18:16:46 EST 
https://git.eclipse.org/r/18058
Comment 2 Lars Vogel CLA 2014-03-20 12:08:19 EDT 
Added one for org.eclipse.e4.ui.workbench.renderers.swt.cocoa 

https://git.eclipse.org/c/platform/eclipse.platform.ui.git/commit/?id=5f56781f42e575a8fa6dff524e180d54816a3dd1
Comment 3 Lars Vogel CLA 2014-04-09 03:14:30 EDT 
Added the link to our "How to contribute" wiki in our main README.md with https://git.eclipse.org/c/platform/eclipse.platform.ui.git/commit/?id=e2d03ba79a0a65c86e1662fd3a2af8e73504c6d1 

I think here we describe the required setup sufficient.
Comment 4 Lars Vogel CLA 2014-04-22 08:55:13 EDT 
Verified in Git