Skip to content

Commit 13a69e8

Browse files
author
André Behrens
committed
refer contributing.md to wiki-page
enables us to modify this file at only one place once we will have other branches [ci skip]
1 parent 8886d96 commit 13a69e8

1 file changed

Lines changed: 3 additions & 56 deletions

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,4 @@
1-
## Contributing to Exchange Web Services Java API
2-
*ews-java-api* is released under the [MIT License](license.txt) and contributors are welcome.
1+
## Contributing.md
32

4-
There are several ways to contribute to the project:
5-
6-
* Report bugs and features in the [issue tracker](https://github.com/officedev/ews-java-api/issues).
7-
* Submit and review pull requests
8-
* Help with documentation
9-
* Help with testing
10-
11-
GitHub supports [markdown](http://github.github.com/github-flavored-markdown/), so when filing bugs make sure you check the formatting before clicking submit.
12-
13-
### Contributing code and content
14-
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:
15-
16-
* [Open Source Contribution Etiquette](http://tirania.org/blog/archive/2010/Dec-31.html) by Miguel de Icaza
17-
* [Don't "Push" Your Pull Requests](http://www.igvita.com/2011/12/19/dont-push-your-pull-requests/) by Ilya Grigorik.
18-
19-
### Coding Conventions
20-
The project is using the _google-styleguide for Java_. Documentation of this style can be found here: [Google Java Style](https://google-styleguide.googlecode.com/svn-history/r130/trunk/javaguide.html)
21-
22-
#### Using IntelliJ
23-
`Settings` -> `Code Style` -> `Scheme` -> _Choose_ `Project`
24-
#### Using Eclipse
25-
* Open *google-styleguide for Java* by clicking on: [google-styleguide](https://google-styleguide.googlecode.com/svn-history/r122/trunk/eclipse-java-google-style.xml)
26-
* Download the file with: “Right click and save as”
27-
* Import the new formatter:
28-
`Window` -> `Preferences` -> `Java` -> `Code Style` -> `Formatter` -> _Choose_ `Import` and `select` the _eclipse-java-google-style.xml_
29-
30-
### Pull Requests
31-
If you don't know what a pull request is read the "[Using pull requests](https://help.github.com/articles/using-pull-requests)" article.
32-
33-
Some guidelines for pull requests:
34-
35-
* Use a descriptive title and description.
36-
* Include a single logical change.
37-
* Base on master branch - once accepted, can be ported to stable branches.
38-
* Should cleanly merge with target branch.
39-
40-
### Sign the Contributor License Agreement (CLA)
41-
Before your pull request can be accepted and merged to the main repository you need to sign the [Contributor License Agreement (CLA)](https://cla.azure.com).
42-
43-
### Commit Messages
44-
1. Separate subject from body with a blank line
45-
2. Limit the subject line to 50 characters
46-
3. Capitalize the subject line
47-
4. Do not end the subject line with a period
48-
5. Use the imperative mood in the subject line (e.g. Fix #123: Make pigs fly).
49-
6. Wrap the body at 72 characters
50-
7. Use the body to explain what and why. The how should be mostly covered by the diff.
51-
52-
References:
53-
54-
* [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/)
55-
* [A Note About Git Commit Messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
56-
* [Guidelines for Commit Messages](https://wiki.gnome.org/Git/CommitMessages)
57-
* [On commit messages](http://who-t.blogspot.de/2009/12/on-commit-messages.html)
3+
### To participate, please visit the project wiki for more information.
4+
*Guidelines can be found* [**HERE**](https://github.com/OfficeDev/ews-java-api/wiki/Contributing)

0 commit comments

Comments
 (0)