diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..2e2ae0aa --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing + +Microsoft Azure Service Fabric and Service Fabric CLI welcome any kind of contribution, whether it be reporting issues or sending pull requests. +When contributing to this repository abide by the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). + +## Code changes + +Follow the [wiki page on contributing](https://github.com/Azure/service-fabric-cli/wiki/Contributing) to submit code changes. + +## Issues and questions + +For questions related to Azure Service Fabric clusters, take a look at the [tag on StackOverflow](https://stackoverflow.com/questions/tagged/azure-service-fabric) +and [official documentation](https://docs.microsoft.com/en-us/azure/service-fabric/). + +### General Service Fabric issues + +If your issue is not specific to the Service Fabric CLI, please use the [Service Fabric issues repository](https://github.com/Azure/service-fabric-issues/issues) to report an issue. + +### CLI specific issues + +If your issue is relevant to the Service Fabric CLI, please use this repositories issue tracker. + +Be sure to search for similar previously reported issues prior to creating a new one. +In addition, here are some good practices to follow when reporting issues: + +- Add a `+1` reaction to existing issues that are affecting you +- Include verbose output (`--debug` flag) when reporting unexpected error messages +- Include the version of sfctl installed, `pip show sfctl` will report this +- Include the version of Service Fabric runtime for the cluster you have selected