From d52a30d91c8582d4467cbb9946486672bc909a9e Mon Sep 17 00:00:00 2001 From: Malachi van der Merwe Date: Wed, 13 Mar 2024 16:32:00 +0200 Subject: [PATCH 1/4] Adds a issue template for reporting enhancements to JCB. --- .gitea/ISSUE_TEMPLATE/b-enhancement.yml | 81 +++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 .gitea/ISSUE_TEMPLATE/b-enhancement.yml diff --git a/.gitea/ISSUE_TEMPLATE/b-enhancement.yml b/.gitea/ISSUE_TEMPLATE/b-enhancement.yml new file mode 100644 index 000000000..b62273bc1 --- /dev/null +++ b/.gitea/ISSUE_TEMPLATE/b-enhancement.yml @@ -0,0 +1,81 @@ +name: Enhancement Request +about: Suggest an idea for JCB +title: "[ENHANCEMENT]: " +labels: + - enhancement +body: + - type: markdown + attributes: + value: | + Thank you for suggesting an enhancement! Your input is crucial for our innovation and progress. To assist us better, please share detailed information about your idea. + - type: textarea + id: enhancement-details + attributes: + label: Enhancement Details + description: Could you detail the enhancement you're suggesting? Explain the issue it addresses or the new feature it introduces. + placeholder: Please give an in-depth explanation of your proposed enhancement. + validations: + required: true + - type: markdown + attributes: + value: | + # Context and Priority + - type: dropdown + id: area + attributes: + label: Which part of the extension will be affected by this enhancement? + multiple: true + options: + - Compilation of component + - Installation of a component + - Installation JCB pkg + - Installation of JCB plugins + - Compiler(admin_view) + - Dashboard(admin_view) + - Joomla Components(admin_views) + - Joomla Component(admin_view) + - Joomla Modules(admin_views) + - Joomla Module(admin_view) + - Joomla Plugins(admin_views) + - Joomla Plugin(admin_view) + - Power(admin_view) + - Powers(admin_views) + - Search(admin_view) + - Admin View(admin_view) + - Admin Views(admin_views) + - Custom Admin Views(admin_views) + - Site View(admin_view) + - Site Views(admin_views) + - Template(admin_view) + - Templates(admin_views) + - Layout(admin_view) + - Layouts(admin_views) + - Dynamic Get(admin_view) + - Dynamic Gets(admin_views) + - Custom Code(admin_view) + - Custom Codes(admin_views) + - Placeholder(admin_view) + - Placeholders(admin_views) + - Library(admin_view) + - Libraries(admin_views) + - Snippet(admin_view) + - Snippets(admin_views) + - Validation Rule(admin_view) + - Validation Rules(admin_views) + - Field(admin_view) + - Fields(admin_views) + - Fieldtypes(admin_views) + - Language Translations(admin_views) + - Server(admin_view) + - Servers(admin_views) + - Help Documents(admin_views) + - Other + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Supply additional context or screenshots related to the enhancement request in this space. + validations: + required: false \ No newline at end of file -- 2.40.1 From 151a1942ac3a8ac43d1ef1083b8bba2204e00483 Mon Sep 17 00:00:00 2001 From: Malachi van der Merwe Date: Wed, 13 Mar 2024 17:47:05 +0200 Subject: [PATCH 2/4] Adds an issue template for reporting the refactoring of specific locations in JCB. --- .gitea/ISSUE_TEMPLATE/f-refactor.yml | 45 ++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 .gitea/ISSUE_TEMPLATE/f-refactor.yml diff --git a/.gitea/ISSUE_TEMPLATE/f-refactor.yml b/.gitea/ISSUE_TEMPLATE/f-refactor.yml new file mode 100644 index 000000000..9245df2e1 --- /dev/null +++ b/.gitea/ISSUE_TEMPLATE/f-refactor.yml @@ -0,0 +1,45 @@ +name: Refactoring Task +about: Recommend or identify the necessity for code refactoring. +title: "[REFACTOR]: " +labels: + - refactor +body: + - type: markdown + attributes: + value: | + We appreciate your commitment to enhancing the maintainability and quality of our codebase! Code refactoring plays a crucial role in ensuring our system remains efficient and easy to manage. To assist us effectively, please share comprehensive details about the refactoring task you are suggesting or identifying. + - type: textarea + id: refactoring-details + attributes: + label: Refactoring Details + description: Outline the refactoring task, specifying which code segment requires attention and the reasons behind this need. What improvements are expected from this refactoring? + placeholder: Provide an in-depth explanation of the refactoring task? + validations: + required: true + - type: markdown + attributes: + value: | + # Affected Components and Context + - type: textarea + id: area + attributes: + label: Which file or area needs refactoring? + description: Where should the refactoring take place? + placeholder: Give a road map where the refactoring should take place. + validations: + required: true + - type: textarea + id: expected-outcome + attributes: + label: Expected Outcome + description: What benefits do you anticipate from this refactoring? How will it enhance the codebase or overall system? + placeholder: Explain the expected results of this refactoring. + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Share any further details or information, like code snippets, that could aid in comprehending or executing the refactoring task. + validations: + required: false -- 2.40.1 From ab4054a7a3edc211a449f07e3d7c76744872ccda Mon Sep 17 00:00:00 2001 From: Malachi van der Merwe Date: Thu, 14 Mar 2024 08:45:44 +0200 Subject: [PATCH 3/4] Adds more detailed questions for f-refactor.yml. --- .gitea/ISSUE_TEMPLATE/f-refactor.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitea/ISSUE_TEMPLATE/f-refactor.yml b/.gitea/ISSUE_TEMPLATE/f-refactor.yml index 9245df2e1..d1181c219 100644 --- a/.gitea/ISSUE_TEMPLATE/f-refactor.yml +++ b/.gitea/ISSUE_TEMPLATE/f-refactor.yml @@ -23,8 +23,8 @@ body: - type: textarea id: area attributes: - label: Which file or area needs refactoring? - description: Where should the refactoring take place? + label: Which file or area of JCB needs refactoring? + description: Which area in JCB should be refactored? placeholder: Give a road map where the refactoring should take place. validations: required: true -- 2.40.1 From 9a9364c81e561b85411d27c1ca9805c5607f8f43 Mon Sep 17 00:00:00 2001 From: Malachi van der Merwe Date: Thu, 14 Mar 2024 09:20:26 +0200 Subject: [PATCH 4/4] 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 -- 2.40.1