From 49aa62bc496b55a55db210de29bbf1cb3f843c1b Mon Sep 17 00:00:00 2001 From: joewxboy Date: Thu, 30 Jul 2026 20:39:39 +0000 Subject: [PATCH] Add issue and PR templates - Added bug report template (.github/ISSUE_TEMPLATE/bug-report.yml) - Added feature request template (.github/ISSUE_TEMPLATE/feature_request.yml) - Added config.yml for GitHub bots - Added pull request template (.github/PULL_REQUEST_TEMPLATE.md) Templates adapted from open-horizon/open-horizon.github.io with modifications specific to web-helloworld-python service. Resolves #6 Signed-off-by: joewxboy --- .github/ISSUE_TEMPLATE/bug-report.yml | 50 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 25 +++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 44 +++++++++++++++++++ .github/config.yml | 46 ++++++++++++++++++++ 4 files changed, 165 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..15aa518 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,50 @@ +name: Bug ReportπŸ› +description: Create a report to help us improve +title: "BugπŸ›: " +labels: [bug] + +body: + - type: markdown + attributes: + value: Thank you for taking the time to file a Bug report for the web-helloworld-python service + - type: textarea + attributes: + label: Describe the bug. + description: "Enter a clear and concise description of what the bug is" + validations: + required: true + - type: textarea + attributes: + label: Describe the steps to reproduce the behavior + description: "Be clear and concise while describing the steps to ensure that it can be reproduced and potentially fixed" + placeholder: | + 1. Deploy the service with '...' + 2. Access the endpoint '....' + 3. Observe the behavior '....' + 4. See error + - type: textarea + attributes: + label: Expected behavior. + description: "Enter a clear and concise description of what you expected to happen" + - type: textarea + attributes: + label: Screenshots or logs. + description: "If applicable, add screenshots or log output to help explain your problem" + - type: input + attributes: + label: Operating environment + description: "What operating system and version are you using? If running on Open Horizon, include the agent version and architecture." + placeholder: | + Ubuntu 20.04.1 LTS, Open Horizon Agent 2.30.0, amd64 + validations: + required: true + - type: input + attributes: + label: Service version + description: "What version of the web-helloworld-python service are you using?" + placeholder: | + 1.0.0 + - type: textarea + attributes: + label: Additional context + description: "Add any other context or screenshots to clarify your issue here." diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..4556ee0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,25 @@ +name: Feature Request +description: Suggest an idea for this project +title: "Feature Request: " +labels: [enhancement] + +body: + - type: markdown + attributes: + value: Thank you for taking the time to file a Feature Request for the web-helloworld-python service. + - type: textarea + attributes: + label: Is your feature request related to a problem? Please describe. + description: 'A clear and concise description of what the problem is. Ex. I am always frustrated when [...]' + - type: textarea + attributes: + label: Describe the solution you'd like. + description: 'A clear and concise description of what you want to happen.' + - type: textarea + attributes: + label: Describe alternatives you've considered + description: 'A clear and concise description of any alternative solutions or features you have considered.' + - type: textarea + attributes: + label: Additional context. + description: 'Add any other context or screenshots about the feature request here.' diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..a826c91 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,44 @@ +## **Description** + +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. + +Fixes # (issue) + +## **Type of change** + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +## **How Has This Been Tested?** + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + +- [ ] Tested locally with Docker +- [ ] Tested with Open Horizon agent +- [ ] Tested service deployment and registration + +## **Additional Context (Please include any Screenshots/logs if relevant)** + +... + +## **Checklist:** + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules +- [ ] I have checked my code and corrected any misspellings +- [ ] I have tagged the reviewers in a comment below in case my pull request is ready for a review +- [ ] I have signed the commit message to agree to Developer Certificate of Origin (DCO) (to certify that you wrote or otherwise have the right to submit your contribution to the project.) by adding "--signoff" to my git commit command. + +--- + +*Thanks for opening this pull request! If the tests fail, please feel free to reach out to us by leaving a comment down below and we will be happy to take a look* diff --git a/.github/config.yml b/.github/config.yml new file mode 100644 index 0000000..cf676b9 --- /dev/null +++ b/.github/config.yml @@ -0,0 +1,46 @@ +--- +# Configuration for welcome - https://github.com/behaviorbot/welcome + +# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome + +# Comment to be posted to on first time issues +newIssueWelcomeComment: | + Hello there!πŸ‘‹ Welcome to the web-helloworld-python service!πŸ’– + Thank you and congratulations πŸŽ‰ for opening your very first issue in this project. + Please checkout if any of the already existing issue template fits for your issue or you may open a blank issue as well ✨ + We will try to get back to you as soon as we can.πŸ‘€ + +# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome + +# Comment to be posted to on PRs from first time contributors in your repository +newPRWelcomeComment: | + Hello there!πŸ‘‹ Welcome to the web-helloworld-python service!πŸ’– + Thank you and congrats πŸŽ‰ for opening your first PR on this project.✨ + We will review it soon! Till then you can checkout the `README.md` for more details on it. + +# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge + +# Comment to be posted to on pull requests merged by a first time user +firstPRMergeComment: | + Congratulations on merging your first contribution to web-helloworld-python!✨ + +# *Required* Comment to reply with +requestInfoReplyComment: > + Hi, + Thanks for raising an issue/pull request! We at web-helloworld-python appreciate your concerns and views to + help us improve. + +# *OPTIONAL* default titles to check against for lack of descriptiveness +# MUST BE ALL LOWERCASE +requestInfoDefaultTitles: + - update readme.md + - updates + - add files via upload + - readme.md + - changes made + +# *OPTIONAL* Label to be added to Issues and Pull Requests with insufficient information given +requestInfoLabelToAdd: needs-more-info + +# It is recommended to include as many gifs and emojis as possible! +---