From 461c52da2c8a45749abc037d1c74ab120d1bc881 Mon Sep 17 00:00:00 2001 From: Kaushik Bokka Date: Mon, 22 Jul 2024 22:11:02 +0530 Subject: [PATCH] enhance: add configuration for issue templates & add docs template as well --- .github/ISSUE_TEMPLATE/config.yml | 14 ++++++++++++++ .github/ISSUE_TEMPLATE/documentation.md | 25 +++++++++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation.md diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..d14c5b3f7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Guardrails Documentation + url: https://www.guardrailsai.com/docs + about: Check our documentation for answers to common questions and usage guides. + - name: Guardrails Hub + url: https://hub.guardrailsai.com/ + about: Explore pre-built validators and guards for specific types of risks. + - name: GitHub Discussions + url: https://github.com/guardrails-ai/guardrails/discussions + about: Ask questions and discuss with other community members about Guardrails. + - name: Join our Discord Community + url: https://discord.com/invite/gw4cR9QvYE + about: Connect with other Guardrails users and get real-time support. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 000000000..f945969b3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,25 @@ +--- +name: Documentation issue +about: Report a problem or suggest an improvement for Guardrails documentation +title: "[docs]" +labels: documentation +assignees: '' + +--- + +**Description** +[Add a clear description of the documentation issue or improvement suggestion] + +**Current documentation** +[Provide a link to the current documentation page or section that needs attention] + +**Suggested changes** +[If you have specific changes in mind, describe them here. Be as detailed as possible] + +**Additional context** +[Add any other context, screenshots, or examples that could help explain the issue or improvement] + +**Checklist** +- [ ] I have checked that this issue hasn't already been reported +- [ ] I have checked the latest version of the documentation to ensure this issue still exists +- [ ] For simple typos or fixes, I have considered submitting a pull request instead