Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

32 lines (22 loc) · 2.32 KB
Raw

Plugin for Terraform Provider for Citrix® Contribution Guide

Thank you for considering contributing to this project! Please follow these guidelines to ensure your effort is inline with our policies and guidelines.

All participation including discussion must adhere to relevant parts of the Cloud Software Group code of business conduct. In short:

  • Act ethically
  • Protect customer information
  • Follow laws and regulations
  • Ask questions and raise concerns

Submitting an Issue

You do not have to know how to code to help us improve the project. Your feedback, bugs and feature requests, help others determine what to prioritize. This project uses GitHub to track all issues.

We ask you not to submit security concerns via GitHub. For details on submitting potential security issues please see https://support.citrix.com/article/CTX081743

When submitting a bug be sure to include:

  • The version of the provider.
  • Your terraform plan with all secrets and identifying information removed.
  • A copy of the terraform console output including any errors and the transactionId if specified.
  • Does the issue occur if you use the product UI or APIs?

Provider issue vs Product issue vs Configuration issue

This project's GitHub tracker is not a replacement for Citrix support.

Sometimes it can be hard to tell if an error coming from the provider is a bug in the provider itself, or an issue with the underlying Citrix services, provider inputs, or infrastructure issues.

It is the goal of this project to enhance the provider to return meaningful and actionable error messages. However the maintainers and contributors do not have full knowledge of all Citrix services and features. They cannot help triage issues that ultimately stem from outside of the provider.

In general if the issue can be reproduced using another mechanism (via the UI, REST APIs, etc) than it is not an issue with the provider. A provider bug can be opened to make the error easier to understand, but Citrix support should be engaged to help fix the underlying issue.

Contributing Code

This project is currently not accepting pull requests from the community. If you'd like to run the provider locally follow the steps in the DEVELOPER.md document.