Skip to content

Latest commit

 

History

History
39 lines (31 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

39 lines (31 loc) · 2.71 KB
Raw

#How to contribute? There are many ways for you to contribute to ODataCpp. The easiest way is to participate in discussion of features and issues. You can also contribute by sending pull requests of features or bug fixes to us. Contribution to the documentations at our Wiki is also highly welcomed. ##Discussion You can participate into discussions and ask questions about ODataCpp at our Github issues. ###Bug reports When reporting a bug at the issue tracker, please use the following template:

### Description
*Does the bug result in any actual functional issue, if so, what?*  

### Minimal repro steps
*What is the smallest, simplest set of steps to reproduce the issue. If needed, provide a project that demonstrates the issue.*  

### Expected result
*What would you expect to happen if there wasn't a bug*  

### Actual result
*What is actually happening*  

### Further technical details
*Optional, details of the root cause if known*

##Pull requests Pull request of features and bug fixes are both welcomed. Before you send a pull request to us, there are a few steps you need to make sure you've followed. ###Complete a Contribution License Agreement (CLA) You will need to complete a Contributor License Agreement (CLA). Briefly, this agreement testifies that you are granting us permission to use the submitted change according to the terms of the project's license, and that the work being submitted is under appropriate copyright.

Please submit a Contributor License Agreement (CLA) before submitting a pull request. Download the agreement ([Microsoft Contribution License Agreement.pdf](https://github.com/odata/odatacpp/wiki/files/Microsoft Contribution License Agreement.pdf)), sign, scan, and email it back to [email protected]. Be sure to include your Github user name along with the agreement. Only after we have received the signed CLA, we'll review the pull request that you send. You only need to do this once for contributing to any Microsoft open source projects.

###Create a new issue on the issue tracker and link the pull request to it You should have an issue created on the issue tracker before you work on the pull request. After the ODataCpp team has reviewed this issue and change its label to "accepting pull request", you can issue a pull request to us in which the link to the related issue is included. ###Requirement of pull requests Your pull request should:

  • Include a description of what your change intends to do
  • Have clear commit messages
  • Include a link to the issue created at the issue tracker or its issue number
  • Include adequate tests