Skip to content

Latest commit

 

History

History
360 lines (275 loc) · 16.7 KB

CONTRIBUTING.md

File metadata and controls

360 lines (275 loc) · 16.7 KB
Raw

Contributing to Eclipse OpenJ9

Thank you for your interest in Eclipse OpenJ9!

We welcome and encourage all kinds of contributions to the project, not only code. This includes bug reports, user experience feedback, assistance in reproducing issues and more. Contributions to the website (https://github.com/eclipse-openj9/openj9-website), to the user documentation (https://github.com/eclipse-openj9/openj9-docs), to the system verification tests (https://github.com/eclipse-openj9/openj9-systemtest), or to Eclipse OMR (https://github.com/eclipse-omr/omr), which is an integral part of OpenJ9 are all also welcome.

Submitting a contribution to OpenJ9

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

  1. Your pull request is an opportunity to explain both what changes you'd like pulled in, but also why you'd like them added. Providing clarity on why you want changes makes it easier to accept, and provides valuable context to review.

  2. Follow the commit guidelines found below.

  3. We encourage you to open a pull request early, and mark it as "Work In Progress", by prefixing the PR title with "WIP". This allows feedback to start early, and helps create a better end product. Committers will wait until after you've removed the WIP prefix to merge your changes.

  4. If your contribution introduces an external change that requires an update to the user documentation, add the label doc:externals to the OpenJ9 issue, or request a committer to do it, and open an issue at the user documentation repository. The OpenJ9 pull request should be labeled with depends:doc as well. Committers should not merge the OpenJ9 pull request until at least a doc issue is created, and ideally not until the doc pull request is ready for merge. Rather than doing it separately, the pull request should add or update the release notes for the next release with a short summary of the change. Examples of an external change include a new command line option, a change in behavior, or a restriction.

    A pull request to update the documentation is required. Do your best to make appropriate updates, and the reviewers will help guide the necessary doc changes.

  5. Contributions from generative artificial intelligence (GenAI) coding assistants are permitted subject to the GenAI Usage Guidelines described below.

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

  7. Ensure your changes are compatible with the checks that will be applied to your pull request.

    • Text files should use the proper line-endings and there should be no unwanted whitespace. You can enable the sample pre-commit hook created by git init to ensure you adhere to expectations.

Building and testing

In order to build OpenJ9, see the build instructions. Once the build system is prepared, building consists of a few simple steps. If building the original source fails, check the level of the compiler being used.

There are a large number of test cases that are run automatically as part of the Eclipse OpenJ9 build and test pipeline. The tests can be triggered by committers from pull requests. You can see the latest results on the Eclipse OpenJ9 Jenkins instance.

The tests can also be run manually on your own machine, refer to the OpenJ9 test quick start guide.

Commit Guidelines

The first line describes the change made. It is written in the imperative mood, and should say what happens when the patch is applied. Keep it short and simple. The first line should be less than 70 characters, where reasonable, and should be written in sentence case (capitalize the first letter) preferably not ending in a period. Leave a blank line between the first line and the message body.

The body should be wrapped at 72 characters, where reasonable.

Include as much information in your commit as possible. You may want to include designs and rationale, examples and code, or issues and next steps. Prefer copying resources into the body of the commit over providing external links. Structure large commit messages with headers, references etc. Remember, however, that the commit message is always going to be rendered in plain text.

Please add [skip ci] to the commit message when the change doesn't require a compilation, such as documentation only changes, to avoid unnecessarily wasting the project's build resources.

When a commit has related issues or commits, explain the relation in the message body. When appropriate, use the keywords described in the following help article to automatically close issues. https://help.github.com/articles/closing-issues-using-keywords/ For example:

Correct race in frobnicator

This patch eliminates the race condition in issue #1234.

Fixes: #1234

Sign off on your commit in the footer. By doing this, you assert original authorship of the commit and that you are permitted to contribute it. This can be automatically added to your commit by passing -s to git commit, or by manually adding the following line to the footer of the commit.

Signed-off-by: Full Name <email>

Remember, if a blank line is found anywhere after the Signed-off-by line, the Signed-off-by: will be considered outside of the footer, and will fail the automated Signed-off-by validation. The email used to sign off the commit must be the same, including case-sensitivity, as the one used to sign the Eclipse ECA, or your commit will fail IP validation.

It is important that you read and understand the legal considerations found below when signing off or contributing any commit.

Example commits

Here is an example of a good commit:

Update and expand the commit guidelines

Elaborate on the style guidelines for commit messages. These new
style guidelines reflect the conversation found in #124.

The guidelines are changed to:
- Provide guidance on how to write a good first line.
- Elaborate on formatting requirements.
- Relax the advice on using issues for nontrivial commits.
- Move issue references from the first line to the message footer.
- Encourage contributors to put more information into the commit
  message.

Closes: #124
Signed-off-by: Robert Young <[email protected]>

The first line is meaningful and imperative. The body contains enough information that the reader understands the why and how of the commit, and its relation to any issues. The issue is properly tagged and the commit is signed off.

The following is a bad commit:

FIX #124: Changing a couple random things in CONTRIBUTING.md.
Also, there are some bug fixes in the thread library.

The commit rolls unrelated changes together in a very bad way. There is not enough information for the commit message to be useful. The first line is not meaningful or imperative. The message is not formatted correctly, the issue is improperly referenced, and the commit is not signed off by the author.

Other resources for writing good commits

Generative Artificial Intelligence Usage Guidelines

The Eclipse OpenJ9 project acknowledges that some contributions may be authored in whole or in part from generative artificial intelligence coding assistants. Such contributions are permitted per the Eclipse Foundation Generative AI Usage Guidelines which describes contributor and committer responsibilities, copyright and licensing considerations, and attribution requirements for GenAI assisted contributions.

All contributors are encouraged to read and understand the advice and guidelines therein before submitting a contribution to Eclipse OpenJ9 even partially generated by an AI coding assistant.

The Eclipse OpenJ9 project is subject to those policies and provides additional guidelines described below for contributors and committers governing GenAI-assisted contributions.

Attribution

Contributions that include GenAI-assisted content must disclose that authorship in each file where GenAI content is present. Contributors must include a statement like the following just below the copyright header at the beginning of the file that acknowledges their AI assistant (assuming such a statement does not already exist).

// Some sections generated by <YOUR AI ASSISTANT>

In addition, individual commits that include GenAI authored content must attribute that at the end of the commit message (before any human authorship signatures).

Co-authored by <YOUR AI ASSISTANT>

Tagging

Some contributors' employers may require their AI-generated code and documentation contributions to be annotated with inline tags providing additional metadata about the generated content for legal and license attribution reasons. Eclipse OpenJ9 will accept contributions that include such metadata with some guidance below for contributors and committers.

Tag Usage

Inline tagging of code or documentation generated by coding assistants is not mandatory.

If tags are used, they must clearly demarcate the boundaries of GenAI-assisted content (e.g., via paired "begin" and "end" code comments). These boundaries may span consecutive lines, functions, paragraphs, or entire files. The term "assisted" is an important qualifier to describe the enclosed content because it may contain a blend of AI-generated content and human contributions. The "assisted" distinction is necessary because it may not be possible to clearly identify just the AI-generated content in the contribution, and it allows for human changes to the demarcated contribution over time while preserving the meaning of the tags.

Tag Format

At this time, Eclipse OpenJ9 does not specify the format of the tags, except that they must not contain any corporate-specific information or other identifiers that have no meaning beyond the original contributor (e.g., internal issue numbers or URLs). Information about the model used to generate the code or documentation is permitted, however.

Tags must be concise and as minimally-invasive as possible. Tags that are excessively verbose or impact the readability of the code or documentation may be rejected by committers at their discretion.

For consistency, tags produced for the same coding assistant must use the same format regardless of the contributor or pull request.

Tag Maintenance

If the contents of a tagged region are modified by a human then any enclosing tags should remain in place.

If code or documentation within a tagged region is copied in whole or in part elsewhere in the project, the original surrounding tags should accompany the copy to its destination. If such code or documentation is copied to a file that does not already have the Eclipse Foundation GenAI attribution after the copyright header, such attribution must be added.

Eclipse OpenJ9 implements a good-faith policy for contributors and committers to maintain GenAI tags in the code and documentation for as long as possible. Existing tags and their boundaries will be maintained on a best-effort basis, and they should not be removed simply for the sake of removing them.

However, there are legitimate situations where GenAI tagging may be considered for removal, including if the tags:

  • interfere with the readability or understandability of the code or documentation,
  • become difficult or unwieldy to maintain (e.g., through code refactoring or code sharing),
  • become obsolete (e.g., information within a tagged section is removed entirely),
  • become redundant (e.g., an inner set of tags is completely consumed by an outer set)

This list is not exhaustive, and the disposition of GenAI tags in a pull request will ultimately be at the discretion of Eclipse OpenJ9 committers who will balance the spirit of these tagging guidelines with the best interests of the Eclipse OpenJ9 project.

Legal considerations

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

Your contribution cannot be accepted unless you have a signed ECA - Eclipse Foundation Contributor Agreement in place. If you have an active signed Eclipse CLA (the CLA was updated by the Eclipse Foundation to become the ECA in August 2016), then that signed CLA is sufficient. You will have to sign the ECA once your CLA expires.

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 ECA".
  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.

Your signing of the ECA will be verified by a webservice called 'ip-validation' that checks the email address that signed-off on your commits has signed the ECA. Note: This service is case-sensitive, so ensure the email that signed the ECA and that signed-off on your commits is the same, down to the case.

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.

Eclipse OpenJ9 is dual-licensed under the Eclipse Public License v2.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 project lead before contributing.
  • For any scenario not covered by this document, please discuss the copyright notice and licensing requirements with a project before contributing.

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

/*******************************************************************************
 * Copyright IBM Corp. and others %s
 *
 * This program and the accompanying materials are made available under
 * the terms of the Eclipse Public License 2.0 which accompanies this
 * distribution and is available at https://www.eclipse.org/legal/epl-2.0/
 * or the Apache License, Version 2.0 which accompanies this distribution and
 * is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * This Source Code may also be made available under the following
 * Secondary Licenses when the conditions for such availability set
 * forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
 * General Public License, version 2 with the GNU Classpath
 * Exception [1] and GNU General Public License, version 2 with the
 * OpenJDK Assembly Exception [2].
 *
 * [1] https://www.gnu.org/software/classpath/license.html
 * [2] https://openjdk.org/legal/assembly-exception.html
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 OR GPL-2.0-only WITH OpenJDK-assembly-exception-1.0
 *******************************************************************************/