Thank you for your interest in the EMF.cloud Coffee Editor IDE project! We welcome your contributions! Before you dive in, please find the following set of guidelines for contributing to EMF.cloud.
This project is governed by the Eclipse Community Code of Conduct. By participating, you are expected to uphold this code.
This repository is subject to the Terms of Use of the Eclipse Foundation.
The following communication channels are available:
- GitHub Discussions - for questions
- GitHub issues - for project wide bug reports, feature requests, etc.
- Developer mailing list - for organizational issues (e.g. elections of new committers)
In case you have a question, please look into the GitHub Discussions first. If you don't find any answer there, feel free to start a new discussion or create a new issue in the respective repository to get help.
This Eclipse Foundation open project is governed by the Eclipse Foundation Development Process and operates under the terms of the Eclipse IP Policy.
In order to contribute, please first open an issue in the respective repository or in this repository if it is an project wide concern. This issue should describe the bug you intend to fix or the feature you would like to add. Once you have your code ready for review, please open a pull request in the respective repository. A committer of the EMF.cloud project will then review your contribution and help to get it merged.
In order to be able to contribute to Eclipse Foundation projects you must electronically sign the Eclipse Contributor Agreement (ECA).
The ECA provides the Eclipse Foundation with a permanent record that you agree that each of your contributions will comply with the commitments documented in the Developer Certificate of Origin (DCO). Having an ECA on file associated with the email address matching the "Author" field of your contribution's Git commits fulfills the DCO's requirement that you sign-off on your contributions.
For more information, please see the Eclipse Committer Handbook.
You must digitally sign the Eclipse Contributor Agreement (ECA). You can do this as follows:
- If you haven't done so already, register an Eclipse account. Important: Use the same email address that you will use on Git commits as the author address.
- Open the ECA form and complete it. See the ECA FAQ for more info.
If you are an elected committer of the EMF.cloud project please create a branch in the respective repository. Otherwise please fork and create a branch in your fork for the pull request.
The branch name should be in the form issues/{issue_number}, e.g. issues/115. So please create an issue before creating a pull request.
All branches with this naming schema will be deleted after they are merged.
In the commit message you should also reference the corresponding issue, e.g. using closes #115 / closes https://github.com/eclipse-emfcloud/coffee-editor/issues/115, thus allowing auto close of issues.
Please make sure you read the guide for a good commit message.