Skip to content
This repository was archived by the owner on Jul 19, 2024. It is now read-only.

Commit 1f0b8de

Browse files
author
jofriedm-msft
authored
Merge pull request #204 from jofriedm-msft/master
Updating contributing doc to include IntelliJ
2 parents 56758d3 + 60b1f8f commit 1f0b8de

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
If you intend to contribute to the project, please make sure you've followed the instructions provided in the [Azure Projects Contribution Guidelines](http://azure.github.io/guidelines/).
22
## Project Setup
3-
The Azure Storage development team uses Eclipse so instructions will be tailored to that preference. However, any preferred IDE or other toolset should be usable.
3+
The Azure Storage development team uses Intellij. However, any preferred IDE or other toolset should be usable.
44

55
### Install
66
* Java SE 6+
7-
* [Eclipse](https://eclipse.org/downloads/)
8-
* [Maven plugin for Eclipse](http://www.eclipse.org/m2e/index.html). Some Eclipse packages (ex Eclipse IDE for Java Developers) may come with this plugin already installed.
97
* [Maven](https://maven.apache.org/install.html)
108
* Clone the source code from GitHub
119

12-
### Open Solution
13-
Open the project from Eclipse using File->Import->Maven->Existing Maven Projects and navigating to the azure-storage-java folder. Select the listed pom. This imports the source and the test files and downloads the required dependencies via Maven. If you'd like to import the samples, follow the same procedure but navigate to the azure-storage-java\microsoft-azure-storage-samples folder and select that pom. Both projects can be opened at the same time and will be shown in the Package Explorer.
10+
#### IntelliJ Installation
11+
* [IntelliJ](https://www.jetbrains.com/idea/download)
12+
* [Importing project from Maven for IntelliJ](https://www.jetbrains.com/help/idea//2017.1/importing-project-from-maven-model.html)
13+
14+
#### Eclipse Installation
15+
* [Eclipse](https://eclipse.org/downloads/)
16+
* [Maven plugin for Eclipse](http://www.eclipse.org/m2e/index.html). Some Eclipse packages (ex Eclipse IDE for Java Developers) may come with this plugin already installed.
17+
* Open the project from Eclipse using File->Import->Maven->Existing Maven Projects and navigating to the azure-storage-java folder. Select the listed pom. This imports the source and the test files and downloads the required dependencies via Maven. If you'd like to import the samples, follow the same procedure but navigate to the azure-storage-java\microsoft-azure-storage-samples folder and select that pom. Both projects can be opened at the same time and will be shown in the Package Explorer.
1418

1519
## Tests
1620

@@ -38,7 +42,7 @@ The following are the minimum requirements for any pull request that must be met
3842
* Thoroughly test your feature
3943

4044
### Branching Policy
41-
Changes should be based on the **dev** branch, not master as master is considered publicly released code. If after discussion with us breaking changes are considered for the library, we will create a **dev_breaking** branch based on dev which can be used to store these changes until the next breaking release. Each breaking change should be recorded in [BreakingChanges.md](BreakingChanges.md).
45+
Changes should be based on the **dev** branch for non-breaking changes and **dev_breaking** for breaking changes. Do not submit pull requests against master as master is considered publicly released code. Each breaking change should be recorded in [BreakingChanges.md](BreakingChanges.md).
4246

4347
### Adding Features for Java 6+
4448
We strive to release each new feature in a backward compatible manner. Therefore, we ask that all contributions be written to work in Java 6, 7 and 8.

0 commit comments

Comments
 (0)