From 87706b19bc90fba3cfd00c682be6981c72263109 Mon Sep 17 00:00:00 2001 From: Malachi van der Merwe Date: Thu, 14 Mar 2024 10:21:14 +0200 Subject: [PATCH] Adds an issue template for the improvement of documentation in JCB. --- .gitea/ISSUE_TEMPLATE/d-docs.yml | 37 ++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 .gitea/ISSUE_TEMPLATE/d-docs.yml diff --git a/.gitea/ISSUE_TEMPLATE/d-docs.yml b/.gitea/ISSUE_TEMPLATE/d-docs.yml new file mode 100644 index 000000000..ac6a62f34 --- /dev/null +++ b/.gitea/ISSUE_TEMPLATE/d-docs.yml @@ -0,0 +1,37 @@ +name: Documentation +about: Propose improvements to the documentation or highlight any issues found within it. +title: "[DOCUMENTATION]: " +labels: + - documentation +body: + - type: markdown + attributes: + value: | + We appreciate your input on our documentation! Clear and comprehensive documentation plays a vital role in enabling users to effectively interact with our systems. To assist us in making improvements, kindly offer thorough details regarding your suggestion or the specific problem you've encountered. + - type: textarea + id: documentation-details + attributes: + label: Documentation Details + description: Please explain the specific problem with the documentation or the improvements you recommend. Is it a missing topic, unclear instructions, outdated content, or something else? + placeholder: Detail the issue with the documentation or suggest improvements.. + validations: + required: true + - type: markdown + attributes: + value: | + # Specific Context + - type: textarea + id: expected-outcome + attributes: + label: Expected Outcome + description: What outcomes do you anticipate from this change in documentation? How will it benifit the users or enhance the project? + placeholder: Explain the expected result of this change in the documentation. + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Share any extra details, files, or screenshots that could help in understanding or applying the documentation change. + validations: + required: false \ No newline at end of file