Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

69 lines (44 loc) · 3.04 KB
Raw

Contributing to Java Release Notes

First off, thanks for taking the time to contribute! 👍

It's not easy to keep up to date with the fast-changing pace of the Java ecosystem.

Table Of Contents

Code of Conduct

How Can I Contribute?

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating in it, you are expected to keep this code. Please report any unacceptable behavior to lealceldeiro@gmail.com.

How Can I Contribute?

Suggesting Enhancements

Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template.

Before Submitting An Enhancement Suggestion

  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub Issues. Create an issue and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Explain why this enhancement would be useful.

Pull Requests

The process described here aims to:

  • Maintain Java Release Notes up to date with the state of the art of the Java ecosystem.

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow all instructions in the template.
  2. Follow the styleguides.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Styleguides

Git Commit Messages

  • Start the commit messages with the issue number (if apply) and a short description of what is this commit about.
  • Use the present tense ("Add description of Java 8 feature" not "Added description of Java 8 feature").
  • Use the imperative mood ("Expand explanation on..." not "Expands explanation on...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line.
  • Use Markdown whenever possible.