Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions sdk/spring/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License
Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For
details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate
the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to
do this once across all repositories using our CLA.

## Code of conduct

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact
[opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

## Getting started

Before working on a contribution, it would be beneficial to familiarize yourself with the project so that your
submission is consistent with the project standards and is ready to be accepted with fewer changes requested.

- [Azure Spring Boot README](./README.md), to learn more about the overall project and processes used.

## Development environment setup

### Prerequisites

- Java Development Kit (JDK) with version 8 or above
- [Maven][maven]
- Git
- Microsoft Azure subscription
- You can create a free account at: https://azure.microsoft.com

## Building from source

To build the project, open a command prompt/terminal:
1. Execute `git clone https://github.com/Azure/azure-sdk-for-java.git`
1. Traverse to the spring directory:
* `cd sdk\spring`
1. Build the product by executing:
* `mvn clean package -DskipTests`

## Running tests

After following instructions above, you can run the
unit tests by executing:
```shell
mvn clean test
```

For unit tests, there are no special considerations; these are self-contained and execute locally without any reliance
on external resources. These tests are run for all PR validations.


## FAQ

When building Spring Boot project, if it fails on the sample `azure-spring-boot-sample-servicebus`, please deploy the
`com.azure:azure-messaging-servicebus` to your local repository manually by:
```shell
cd sdk\servicebus\azure-messaging-service
mvn clean install -DskipTests
```
This is because the version of `com.azure:azure-messaging-servicebus` library the sample depends on is from this SDK
repository instead of Maven.

## Version management
Developing version naming convention is like `0.1.2-beta.1`. Release version naming convention is like `0.1.2`.

## Contribute to code
Contribution is welcome. Please follow
[this instruction](https://github.com/Azure/azure-sdk-for-java/blob/master/CONTRIBUTING.md) to contribute code.

<!-- Links -->
[maven]: https://maven.apache.org/
2 changes: 1 addition & 1 deletion sdk/spring/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ You could check below articles to learn more on usage of specific starters.
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

Please follow [instructions here](https://github.com/Azure/azure-sdk-for-java/blob/master/CONTRIBUTING.md) to build from source or contribute.
Please follow [instructions here](./CONTRIBUTING.md) to build from source or contribute.

### Filing Issues

Expand Down