Skip to content

Latest commit

 

History

History
65 lines (38 loc) · 3.41 KB

CONTRIBUTING.md

File metadata and controls

65 lines (38 loc) · 3.41 KB

Contributing to Eclipse Cargo Tracker

Thanks for your interest in this project. Your feedback and contributions are most welcome. Please consider contacting the developers of the project before proposing a change, ideally via the mailing list.

Project description

The project demonstrates how you can develop applications with Jakarta EE using widely adopted architectural best practices like Domain-Driven Design (DDD).

Developer resources

The project maintains the following source code repository. The project is built using Maven.

Issues are tracked on GitHub. Please look through the issues before proposing a change.

The following are the project web site and documentation. Please look through them before proposing a change.

Development Standards/Style

This project complies with the Google Style Guides for Java, JavaScript, and HTML/CSS. You can use the google-java-format tool to help you comply with the Google Java Style Guide. You can use the tool with most major IDEs such as Eclipse, Visual Studio Code, and IntelliJ.

In general for all files we use a column/line width of 80 whenever possible and we use 2 spaces for indentation. All files must end with a new line. Please adjust the formatting settings of your IDE accordingly. You are encouraged but not required to use HTML Tidy and CSS Tidy to help format your code.

Roadmap

The project is currently stable with no major releases planned in the short term until Jakarta EE 11 is released and well adopted.

Work on any issues or other changes are welcome, especially issues marked with the 'good first issue' (https://github.com/eclipse-ee4j/cargotracker/labels/good%20first%20issue) and 'help wanted' (https://github.com/eclipse-ee4j/cargotracker/labels/help%20wanted) labels.

Eclipse Development Process

This Eclipse Foundation open project is governed by the Eclipse Foundation Development Process and operates under the terms of the Eclipse IP Policy.

Eclipse Contributor Agreement

Before your contribution can be accepted by the project team contributors must electronically sign the Eclipse Contributor Agreement (ECA).

Commits that are provided by non-committers must have a Signed-off-by field in the footer indicating that the author is aware of the terms by which the contribution has been provided to the project. The non-committer must additionally have an Eclipse Foundation account and must have a signed Eclipse Contributor Agreement (ECA) on file.

For more information, please see the Eclipse Committer Handbook: https://www.eclipse.org/projects/handbook/#resources-commit

Contact

Contact the project developers via the project's "dev" list. Please consider posting to the list before submitting an issue or pull request.