Skip to content

Latest commit

 

History

History
102 lines (79 loc) · 4.95 KB

CONTRIBUTING.md

File metadata and controls

102 lines (79 loc) · 4.95 KB
Raw

Contributing to Eclipse OMR

Thanks for your interest in this project.

Project description

The Eclipse OMR project consists of a highly integrated set of open source C and C++ components that can be used to build robust language runtimes that will support many different hardware and operating system platforms. These components include but are not limited to: memory management, threading, platform port (abstraction) library, diagnostic file support, monitoring support, garbage collection, and native Just In Time compilation. The long term goal for the Eclipse OMR project is to foster an open ecosystem of language runtime developers to collaborate and collectively innovate with hardware platform designers, operating system developers, as well as tool and framework developers and to provide a robust runtime technology platform so that language implementers can much more quickly and easily create more fully featured languages to enrich the options available to programmers.

GitHub Issues

This project uses GitHub Issues to track ongoing development and issues. Be sure to search for existing bugs before you create another one. Contributions are always welcome!

Submitting a contribution

You can propose contributions by sending pull requests through GitHub. Following these guidelines will help us to merge your pull requests smoothly:

  1. It is generally a good idea to file an issue to explain your idea before writing code or submitting a PR, especially when introducing new features. Trivial (must be single commit and very obvious change) PRs may be accepted without an issue if the change really is simple, but committers have the right to request an issue for any change. If in doubt, create an issue.

  2. Please read carefully and adhere to the legal considerations and copyright/license requirements outlined below.

  3. Follow the coding style and format of the code you are modifying (see doc/CodingStandard.md)

  4. All commits must be signed (see Legal considerations, below) and use the following commit template ("#n" only needed if there is an issue):

    Short, simple summary that must include #n

Detailed information if required

Signed-off-by: First Last <email>

  5. Ensure that "make test" passes all tests before you submit a Pull Request.

  6. The pull request should reference the issue number with "#n" in the discussion remark, not just the title.

Legal considerations

Please read the Eclipse Foundation policy on accepting contributions via Git.

Your contribution cannot be accepted unless you have an Eclipse Foundation Contributor License Agreement in place.

Here is the checklist for contributions to be acceptable:

  1. Create an account at Eclipse.
  2. Add your GitHub user name in your account settings.
  3. Log into the project's portal and sign the "Eclipse CLA".
  4. Ensure that you sign-off your Git commits.
  5. Ensure that you use the same email address as your Eclipse account in commits.
  6. Include the appropriate copyright notice and license at the top of each file.

Copyright Notice and Licensing Requirements

It is the responsibility of each contributor to obtain legal advice, and to ensure that their contributions fulfill the legal requirements of their organization. This document is not legal advice.

OMR is dual-licensed under the Eclipse Public License v1.0 and the Apache License v2.0. Any previously unlicensed contribution should be released under the same license.

  • If you wish to contribute code under a different license, you must consult with a committer before contributing.
  • For any scenario not covered by this document, please discuss the copyright notice and licensing requirements with a committer before contributing.

The template for the copyright notice and dual-license is as follows:

/*******************************************************************************
 *
 * <Insert appropriate copyright notice here>
 *
 *  This program and the accompanying materials are made available
 *  under the terms of the Eclipse Public License v1.0 and
 *  Apache License v2.0 which accompanies this distribution.
 *
 *      The Eclipse Public License is available at
 *      http://www.eclipse.org/legal/epl-v10.html
 *
 *      The Apache License v2.0 is available at
 *      http://www.opensource.org/licenses/apache2.0.php
 *
 * Contributors:
 *    <First author> - initial implementation and documentation
 *******************************************************************************/