Contributing
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.
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:
- Open Source Contribution Etiquette by Miguel de Icaza
- Don't "Push" Your Pull Requests by Ilya Grigorik.
The project is using the google-styleguide for Java. Documentation of this style can be found here: Google Java Style
Settings -> Code Style -> Scheme -> Choose Project
- 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-> ChooseImportandselectthe eclipse-java-google-style.xml
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.
Before your pull request can be accepted and merged to the main repository you need to sign the Contributor License Agreement (CLA).
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line (e.g. Fix #123: Make pigs fly).
- Wrap the body at 72 characters
- Use the body to explain what and why. The how should be mostly covered by the diff.
References:
Copyright © 2015 Microsoft Corporation - Project is released under the terms of the MIT License