Guidelines for contributing to CDI via the Expert Group (EG)

EG Membership

We develop CDI using an open mailing list. You don’t have to be an official member of the expert group to be part of the CDI community. We take into account all input from any member of the list

You should note that by using any of the communication mechanisms associated with CDI (including the mailing list, the JIRA issue tracker and the github repository) you agree that:

  • for all code provided, you are licensing the code under the Apache License, Version 2.

  • for all other ideas provided, the provider waives all patent and other intellectual property rights inherent in such information.

Resources

In addition to the mailing lists, we use JIRA to track issues https://issues.jboss.org/browse/CDI. If you want to register an error in the specification (JIRA calls this a Bug), request a clarification (JIRA calls this a Clarification) or request a new feature (JIRA calls this a Feature Request), please create an issue.

When you create an issue please set the Affects Version to 1.2 and do not set a Fix Version. The CDI specification lead (Pete Muir or Antoine Sabot-Durand) will check the issue, and either request clarification if the report is not clear, or raise it with the EG to discuss whether it should be fixed for 2.0.

The current draft of the specification is available on github at http://github.com/cdi-spec/cdi - you are welcome to clone this repository, and create patches and submit pull requests if you wish. It is the duty of the specification lead to ensure that the specification is consistent and well written, so expect some backwards and forwards before your patch is accepted!

Having crafted your changes, please push them to your fork on github, and then create a pull request. This creates an easy forum in which the EG can review your changes.

Guidelines for interacting with the EG

We hope the EG can be a friendly and informal place to work, and as such we have laid out a few guidelines which it will help if you follow.

  1. Consider whether you want to send an email, or add a comment in JIRA. If you wish to discuss the merits of a change or request more explanation of a proposed change, then send an email. If you want to make a technical proposal or propose an API design, add a comment to an issue. There are no hard and fast rules about when to send an email vs add a comment, but remember that comments are there for posterity, and can help people understand why certain design decision was made.

  2. Try to make every post or comment say something meaningful. Endless "I agree" or "+1" emails aren't that useful and distract from the real discussion about API improvements. Of course, if you strongly disagree with a proposal, please speak up, but in general silence is taken as approval! IRC is probably a better place if you want an informal exchange.

  3. Please try keep the EG a pleasant place - there is no need for rants, swearing or personal comments - these cannot help the specification in anyway. If you want to make an argument, back it up with concrete statements and examples.

We try to reach a consensus decision on all issues. If we can't reach a consensus, we use polls to see what the wider community thinks. For issues on which a consensus still cannot be reached, and require a vote, we take the EG list from the JCP as the voting group. So far, whilst developing CDI 1.1, we only had to vote on one issue.

Issue Resolution Rules

For minor issues where there is obvious fix and no one from the EG has commented, a pull request will be created and once reviewed by the spec lead, merged into master.

For minor issues where there is discussion about how to fix, and for all major issues, a pull requests created when it appears that a consensus has been reached in the EG. Normally, the pull request will not be merged for at least 2 weeks, giving the EG time to review. If issues are raised by the EG then these will be addressed and the 2 week period restarted.

If the EG cannot reach consensus, then a simple majority will decide the outcome (as determined by the spec lead). A similar 2 week period applies.

Close to submission deadlines, the 2 week period may be truncated.

Community Sponsored Issues

There are a number of issues which have merit (i.e. are addressing a valid problem/use case for CDI) but which have not been identified as a priority by the spec lead. If an EG member wishes to see this issue resolved in the spec, then they can sponsor the issue. Practically this means that the sponsor:

  • is responsible for the spec changes (with help/review from spec lead)
  • is responsible for TCK tests (help from TCK lead, review from spec lead)
  • is not responsible for implementing the feature in the RI