|
| 1 | +# Contributing to Eclipse Wild Web Developer |
| 2 | + |
| 3 | +Welcome to the Eclipse Wild Web Developer contributor land, and thanks in advance for your help in making Eclipse Wild Web Developer better and better! |
| 4 | + |
| 5 | +## ⚖️ Legal and Eclipse Foundation terms |
| 6 | + |
| 7 | +The project license is available at [LICENSE](LICENSE). |
| 8 | + |
| 9 | +This Eclipse Foundation open project is governed by the Eclipse Foundation |
| 10 | +Development Process and operates under the terms of the Eclipse IP Policy. |
| 11 | + |
| 12 | +Before your contribution can be accepted by the project team, |
| 13 | +contributors must have an Eclipse Foundation account and |
| 14 | +must electronically sign the Eclipse Contributor Agreement (ECA). |
| 15 | + |
| 16 | +* [http://www.eclipse.org/legal/ECA.php](http://www.eclipse.org/legal/ECA.php) |
| 17 | + |
| 18 | +For more information, please see the Eclipse Committer Handbook: |
| 19 | +[https://www.eclipse.org/projects/handbook/#resources-commit](https://www.eclipse.org/projects/handbook/#resources-commit). |
| 20 | + |
| 21 | +## 💬 Get in touch with the community |
| 22 | + |
| 23 | +Eclipse Wild Web Developer use mainly 2 channels for technical discussions: |
| 24 | + |
| 25 | +* 🐞 View and report issues through uses GitHub Issues at https://github.com/eclipse/wildwebdeveloper/issues. |
| 26 | +* 🗪 Technical discussions that are not yet qualified as issue are happening in GitHub Discussions at https://github.com/eclipse/wildwebdeveloper/discussions |
| 27 | + |
| 28 | +Project committers must 📧 join the [email protected] mailing-list which must be used (according the the Eclipse Development Process) for formal project development decision such as committers and project lead elections. |
| 29 | + |
| 30 | +## 🆕 Trying latest builds |
| 31 | + |
| 32 | +Latest builds, for testing, can usually be found at `https://download.eclipse.org/wildwebdeveloper/snapshots/` . |
| 33 | + |
| 34 | +## 🧑💻 Developer resources |
| 35 | + |
| 36 | +### Prerequisites |
| 37 | + |
| 38 | +Java 17 and Maven 3.8.6 (only if you want to build from the command-line), or newer. |
| 39 | + |
| 40 | +### ⌨️ Setting up the Development Environment manually |
| 41 | + |
| 42 | +* Clone this repository <a href="https://mickaelistria.github.io/redirctToEclipseIDECloneCommand/redirect.html"><img src="https://mickaelistria.github.io/redirctToEclipseIDECloneCommand/cloneToEclipseBadge.png" alt="Clone to Eclipse IDE"/></a>. |
| 43 | +* Run a build via command-line as mentioned below, as some resource provisioning steps will not run in the IDE. |
| 44 | +* _File > Open Projects from Filesystem..._ , select the path to wildwebdeveloper Git repo and the relevant children projects you want to import |
| 45 | +* Depending on the task you're planning to work on, multiple workflows are available to configure the [target-platform](https://help.eclipse.org/2022-09/topic/org.eclipse.pde.doc.user/concepts/target.htm?p=4_1_5) |
| 46 | + * In many cases, this simplest workflow will be sufficient: Install latest Wild Web Developer snapshot in your target-platform (can be your current IDE) as described above, or |
| 47 | + * open __target-platform/target-platform.target__ in your IDE using the Target Definition editor and _Set as Target-Platform_ from the editor |
| 48 | +* Open the project modules you want to work on (right-click > Open project) and their dependencies |
| 49 | +* Happy coding! |
| 50 | + |
| 51 | + |
| 52 | +### 🏗️ Build |
| 53 | + |
| 54 | +Simply `mvn clean verify`, this will run the tests (`-DskipTests` to skip them) and the resulting p2 repository and specific IDE applications will be available for further manual testing in `repository/target`. |
| 55 | + |
| 56 | +### ⬆️ Version bump |
| 57 | + |
| 58 | +Wild Web Developer tries to use OSGi Semantic Version (to properly expose its API contracts and breakage) and Reproducible Version Qualifiers (to minimize the avoid producing multiple equivalent artifacts for identical source). This requires the developer to manually bump version from time to time. Somes rules are that: |
| 59 | + |
| 60 | +* Versions are bumped on a __per module grain__ (bump version of individual bundles/features one by one when necessary), __DON'T bump version of parent pom, nor of other modules you don't change__ |
| 61 | +* __Versions are bumped maximum once per release__ (don't bump versions that were already bumped since last release) |
| 62 | +* __Don't bump versions of what you don't change__ |
| 63 | +* __Bump version of the bundles you're modifying only if it's their 1st change since last release__ |
| 64 | +* Version bump may need to be cascaded to features that *include* the artifact you just changed, and then to features that *include* such features and so on (unless the version of those features were already bumped since last release). |
| 65 | + |
| 66 | +The delta for version bumps are: |
| 67 | + |
| 68 | +* `+0.0.1` (next micro) for a bugfix, or an internal change that doesn't surface to APIs |
| 69 | +* `+0.1.0` (next minor) for an API addition |
| 70 | +* `+1.0.0` (next major) for an API breakage (needs to be discussed on the mailing-list first) |
| 71 | +* If some "smaller" bump already took place, you can replace it with your "bigger one". Eg, if last release has org.eclipse.m2e.editor 1.16.1; and someone already bumped version to 1.16.2 (for an internal change) and you're adding a new API, then you need to change version to 1.17.0 |
| 72 | + |
| 73 | +### ➕ Submit changes |
| 74 | + |
| 75 | +Wild Web Developer only accepts contributions via GitHub Pull Requests against [https://github.com/eclipse/wildwebdeveloper](https://github.com/eclipse/wildwebdeveloper) repository. |
0 commit comments