Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

57 lines (43 loc) · 3 KB
Raw

Contributing to Exchange Web Services Java API

ews-java-api is released under the MIT License and contributors are welcome.

There are several ways to contribute to the project:

  • Report bugs and features in the issue tracker.
  • Submit and review pull requests
  • Help with documentation
  • Help with testing

GitHub supports markdown, so when filing bugs make sure you check the formatting before clicking submit.

Contributing code and content

Before submitting a feature or substantial code contribution please discuss it with the team and ensure it follows the product roadmap. You might also read these two blogs posts on contributing code:

Coding Conventions

The project is using the google-styleguide for Java. Documentation of this style can be found here: Google Java Style

Using IntelliJ

Settings -> Code Style -> Scheme -> Choose Project

Using Eclipse

  • Open google-styleguide for Java by clicking on: google-styleguide
  • Download the file with: “Right click and save as”
  • Import the new formatter: Window -> Preferences -> Java -> Code Style -> Formatter -> Choose Import and select the eclipse-java-google-style.xml

Pull Requests

If you don't know what a pull request is read the "Using pull requests" article.

Some guidelines for pull requests:

  • Use a descriptive title and description.
  • Include a single logical change.
  • Base on master branch - once accepted, can be ported to stable branches.
  • Should cleanly merge with target branch.

Sign the Contributor License Agreement (CLA)

Before your pull request can be accepted and merged to the main repository you need to sign the Contributor License Agreement (CLA).

Commit Messages

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line (e.g. Fix #123: Make pigs fly).
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why. The how should be mostly covered by the diff.

References: