Adding GitHub templates (#90)
This commit is contained in:
John Taubensee
GitHub
Родитель
2f87f65896
Коммит
260c61ef9b
|
|
@ -0,0 +1,50 @@
|
|||
# Contribute or Provide Feedback for Azure Event Hubs .NET Standard library
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Code of Conduct](#code-of-conduct)
|
||||
- [Filing Issues](#filing-issues)
|
||||
- [Pull Requests](#pull-requests)
|
||||
- [General guidelines](#general-guidelines)
|
||||
- [Testing guidelines](#testing-guidelines)
|
||||
|
||||
## 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.
|
||||
|
||||
## Filing Issues
|
||||
|
||||
You can find all of the issues that have been filed in the [Issues](https://github.com/Azure/azure-event-hubs-dotnet/issues) section of the repository.
|
||||
|
||||
If you encounter any bugs, please file an issue [here](https://github.com/Azure/azure-event-hubs-dotnet/issues/new) and make sure to fill out the provided template with the requested information.
|
||||
|
||||
To suggest a new feature or changes that could be made, file an issue the same way you would for a bug, but remove the provided template and replace it with information about your suggestion.
|
||||
|
||||
### Pull Requests
|
||||
|
||||
If you are thinking about making a large change to this library, **break up the change into small, logical, testable chunks, and organize your pull requests accordingly**.
|
||||
|
||||
You can find all of the pull requests that have been opened in the [Pull Request](https://github.com/Azure/azure-event-hubs-dotnet/pulls) section of the repository.
|
||||
|
||||
To open your own pull request, click [here](https://github.com/Azure/azure-event-hubs-dotnet/compare). When creating a pull request, keep the following in mind:
|
||||
- Make sure you are pointing to the fork and branch that your changes were made in
|
||||
- The pull request template that is provided **should be filled out**; this is not something that should just be deleted or ignored when the pull request is created
|
||||
- Deleting or ignoring this template will elongate the time it takes for your pull request to be reviewed
|
||||
|
||||
#### General guidelines
|
||||
|
||||
The following guidelines must be followed in **EVERY** pull request that is opened.
|
||||
|
||||
- Title of the pull request is clear and informative
|
||||
- There are a small number of commits that each have an informative message
|
||||
- A description of the changes the pull request makes is included, and a reference to the bug/issue the pull request fixes is included, if applicable
|
||||
- All files have the Microsoft copyright header
|
||||
|
||||
#### Testing guidelines
|
||||
|
||||
The following guidelines must be followed in **EVERY** pull request that is opened.
|
||||
|
||||
- Pull request includes test coverage for the included changes
|
||||
- Tests must use xunit
|
||||
- Test code should not contain hard coded values for resource names or similar values
|
||||
- Test should not use App.config files for settings
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
## Actual Behavior
|
||||
1.
|
||||
2.
|
||||
|
||||
## Expected Behavior
|
||||
1.
|
||||
2.
|
||||
|
||||
## Versions
|
||||
- OS platform and version:
|
||||
- .NET Version:
|
||||
- NuGet package version or commit ID:
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
## Description
|
||||
<!--
|
||||
Please add an informative description that covers the changes made by the pull request.
|
||||
|
||||
If applicable, reference the bug/issue that this pull request fixes here.
|
||||
-->
|
||||
|
||||
This checklist is used to make sure that common guidelines for a pull request are followed.
|
||||
|
||||
- [ ] **I have read the [contribution guidelines](./CONTRIBUTING.md).**
|
||||
- [ ] Title of the pull request is clear and informative.
|
||||
- [ ] There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR.
|
||||
- [ ] The pull request does not introduce breaking changes (unless a major version change occurs in the assembly and module).
|
||||
- [ ] If applicable, the public code is properly documented.
|
||||
- [ ] Pull request includes test coverage for the included changes.
|
||||
- [ ] The code builds without any errors.
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
## What to contribute
|
||||
There are many ways that you can contribute to the Azure Event Hubs 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
|
||||
|
||||
## Contributing Code
|
||||
To contribute code you need to issue a Pull Request against the develop branch. All code submissions will be reviewed and tested by the team, and those that meet a high bar for both quality and design/roadmap appropriateness will be merged into the source. Be sure to follow the existing file/folder structure when adding new boards or sensors.
|
||||
|
||||
You must sign a [Contribution License Agreement](https://cla.microsoft.com/) ([CLA](https://cla.microsoft.com/)) before submitting a Pull Request. To complete the CLA, you will need to submit the request via the form and then electronically sign the CLA when you receive the email containing the link to the document.
|
||||
|
||||
## Big contributions
|
||||
If your contribution is significantly big it is better to first check with the project developers in order to make sure the change aligns with the long term plans. This can be done simply by submitting a question via the GitHub Issues section.
|
||||
|
||||
## Things to keep in mind when contributing
|
||||
Some guidance for when you make a contribution:
|
||||
|
||||
* Add/update unit tests and code as required by your change
|
||||
* Make sure you run all the unit tests on the affected platform(s)/languages. If the change is in common code, generally running on one platform would be acceptable.
|
||||
* Run end-to-end tests or simple sample code to make sure the lib works in an end-to-end scenario.
|
||||
20
readme.md
20
readme.md
|
|
@ -16,6 +16,10 @@ Azure Event Hubs is a highly scalable publish-subscribe service that can ingest
|
|||
|
||||
Refer to the [online documentation](https://azure.microsoft.com/services/event-hubs/) to learn more about Event Hubs in general.
|
||||
|
||||
## How to provide feedback
|
||||
|
||||
See our [Contribution Guidelines](./.github/CONTRIBUTING.md).
|
||||
|
||||
## Overview
|
||||
|
||||
The .NET client library for Azure Event Hubs allows for both sending events to and receiving events from an Azure Event Hub.
|
||||
|
|
@ -57,19 +61,3 @@ In order to run the unit tests, you will need to do the following:
|
|||
<a href="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-event-hubs-dotnet%2Fmaster%2Ftemplates%2Fazuredeploy.json" target="_blank">
|
||||
<img src="http://azuredeploy.net/deploybutton.png"/>
|
||||
</a>
|
||||
|
||||
## How to provide feedback
|
||||
|
||||
First, if you experience any issues with the runtime behavior of the Azure Event Hubs service, please consider filing a support request
|
||||
right away. Your options for [getting support are enumerated here](https://azure.microsoft.com/support/options/). In the Azure portal,
|
||||
you can file a support request from the "Help and support" menu in the upper right hand corner of the page.
|
||||
|
||||
If you find issues in this library or have suggestions for improvement of code or documentation, [you can file an issue in the project's
|
||||
GitHub repository](https://github.com/Azure/azure-event-hubs-dotnet/issues). Issues related to runtime behavior of the service, such as
|
||||
sporadic exceptions or apparent service-side performance or reliability issues can not be handled here.
|
||||
|
||||
Generally, if you want to discuss Azure Event Hubs or this client library with the community and the maintainers, you can turn to
|
||||
[stackoverflow.com under the #azure-eventhub tag](http://stackoverflow.com/questions/tagged/azure-eventhub) or the
|
||||
[MSDN Service Bus Forum](https://social.msdn.microsoft.com/Forums/en-US/home?forum=servbus).
|
||||
|
||||
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.
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче