Skip to content

Commit

Permalink
[Service Bus] update contributing guide as per guidelines (#1855)
Browse files Browse the repository at this point in the history
  • Loading branch information
ramya-rao-a authored Mar 30, 2019
1 parent 355c0f1 commit 4ef5965
Showing 1 changed file with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions packages/@azure/servicebus/data-plane/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
# 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.

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.

## What to contribute
There are many ways that you can contribute to the Azure ServiceBus client project:
There are many ways that you can contribute to the Azure Service Bus client project:

* Submit a bug
* Submit a code fix for a bug
* Submit code to add a new platform/language support to the project, or modify existing code
* Submit additions or modifications to the documentation
* Submit a feature request

Expand All @@ -23,19 +37,16 @@ Some guidance for when you make a contribution:
* Run end-to-end tests or simple sample code to make sure the lib works in an end-to-end scenario.

## Building the library
- Clone the repo and cd to the repo directory
```
git clone https://github.com/azure/azure-service-bus-node.git
cd azure-service-bus-node
```
- Install typescript, ts-node globally (optional, but very useful)
```
npm i -g typescript
npm i -g ts-node
```
- NPM install from the root of the package
- Clone the repo, cd to the sub folder for service bus and install the dependencies
```
npm i
git clone https://github.com/azure/azure-sdk-for-js.git
cd azure-sdk-for-js/packages/@azure/servicebus/data-plane
npm install
```
- Build the project
```
Expand All @@ -47,4 +58,4 @@ npm run build
If you want to run or debug tests in this project, please see our [Test README](https://github.com/Azure/azure-service-bus-node/blob/master/test/README.md).

## AMQP Dependencies ##
It depends on [rhea-promise](https://github.com/amqp/rhea-promise) library for managing connections, sending and receiving messages over the [AMQP](http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-complete-v1.0-os.pdf) protocol.
The Service Bus library depends on the [rhea-promise](https://github.com/amqp/rhea-promise) library for managing connections, sending and receiving messages over the [AMQP](http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-complete-v1.0-os.pdf) protocol.

0 comments on commit 4ef5965

Please sign in to comment.