This is an automated email from the ASF dual-hosted git repository.
shanedell pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/daffodil-vscode.git
The following commit(s) were added to refs/heads/main by this push:
new a32e1e0 Added issue templates and pull request template
a32e1e0 is described below
commit a32e1e0f31fb963d5ad9d6fa92576d20a24fc3d0
Author: Hitesh Dalsania <[email protected]>
AuthorDate: Mon Sep 1 14:55:51 2025 -0400
Added issue templates and pull request template
---
.github/ISSUE_TEMPLATE/Bug_Report.md | 42 ++++++++++++++++++++
.github/ISSUE_TEMPLATE/Enhancement_Request.md | 32 ++++++++++++++++
.github/ISSUE_TEMPLATE/Feature_Request.md | 55 +++++++++++++++++++++++++++
.github/pull_request_template.md | 32 ++++++++++++++++
.github/workflows/documentaion.yml | 43 +++++++++++++++++++++
5 files changed, 204 insertions(+)
diff --git a/.github/ISSUE_TEMPLATE/Bug_Report.md
b/.github/ISSUE_TEMPLATE/Bug_Report.md
new file mode 100644
index 0000000..35d9f7e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/Bug_Report.md
@@ -0,0 +1,42 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+## Description
+
+[A clear and concise description of what the bug is.]
+
+## Steps to Reproduce
+
+[1. Go to '...'
+2. Click on '...'
+3. See error]
+
+## Expected Behavior
+
+[What did you expect to happen?]
+
+## Actual Behavior
+
+[What actually happened?]
+
+## Additional Notes and Screenshots (optional)
+
+## Environment
+
+[- OS:
+- Browser/VS Code version:
+- Extension version: ]
diff --git a/.github/ISSUE_TEMPLATE/Enhancement_Request.md
b/.github/ISSUE_TEMPLATE/Enhancement_Request.md
new file mode 100644
index 0000000..4de350c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/Enhancement_Request.md
@@ -0,0 +1,32 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# Enhancement Request: [Concise Title of Enhancement]
+
+## Summary
+
+[Provide a brief, high-level overview of the proposed enhancement. What is it,
and what problem does it solve?]
+
+## Proposed Solution / Description
+
+[Describe the enhancement in detail. How will it work? What are the key
features or changes involved? Include any relevant technical details, design
considerations, or user flows. You can use bullet points, numbered lists, code
blocks, and diagrams/pictures for clarity.]
+
+### Addtional Notes
+
+- [**New Feature:** Add a search bar to the user dashboard.
+- **Improved Workflow:** Streamline the data import process by adding a
progress indicator.
+- **Technical Changes:** Implement a new API endpoint for `GET
/users/{id}/data`.]
diff --git a/.github/ISSUE_TEMPLATE/Feature_Request.md
b/.github/ISSUE_TEMPLATE/Feature_Request.md
new file mode 100644
index 0000000..98de019
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/Feature_Request.md
@@ -0,0 +1,55 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# Feature Request: [Concise Title of the Feature]
+
+## Problem Description
+
+[Clearly describe the problem or pain point this feature aims to solve.
Explain the current limitations or challenges faced by users or the system.]
+
+## Proposed Solution
+
+[Detail the proposed solution for the feature. Describe how it will work,
including key functionalities and user interactions. If applicable, mention any
technical considerations or architectural changes.]
+
+## User Stories (Optional but Recommended)
+
+Provide one or more user stories to illustrate how users will interact with
and benefit from the feature.
+[* As a [type of user], I want to [action], so that [benefit].
+* As a [type of user], I want to [action], so that [benefit].]
+
+## Acceptance Criteria
+
+List the specific conditions that must be met for the feature to be considered
complete and successful. These should be testable and measurable.
+[* [Criterion 1]
+* [Criterion 2]
+* [Criterion 3]]
+*
+## Impact and Benefits
+
+[Explain the expected positive impact of this feature on users, the product,
or the business. Quantify benefits where possible.]
+
+## Alternatives Considered (Optional)
+
+[If other solutions were explored and rejected, briefly describe them and
explain why the chosen solution is preferred.]
+
+## Dependencies (Optional)
+
+[List any other features, systems, or data that this feature relies on.]
+
+## Open Questions / Discussion Points (Optional)
+
+[Include any unresolved questions or areas that require further discussion or
clarification.]
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..d243b27
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,32 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+Closes #[issue]
+
+## Description
+
+[Please include a summary of the change and which issue is fixed. Also include
relevant context or motivation.]
+
+## Wiki
+
+- [ ] I have determined that no documentation updates are needed for these
changes
+- [ ] I have added following documentation for these changes
+
+[List added wiki/docs documentaion here for review, if applicable]
+
+## Review Instructions including Screenshots
+[Add review instructions including screenshots or GIFs to help explain the
change visually.]
diff --git a/.github/workflows/documentaion.yml
b/.github/workflows/documentaion.yml
new file mode 100644
index 0000000..6b61105
--- /dev/null
+++ b/.github/workflows/documentaion.yml
@@ -0,0 +1,43 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+---
+name: Enforce Documentation Checkbox
+
+on:
+ push:
+ branches-ignore:
+ - "dependabot/**" # dependabot PRs/branches
+ - "update/**" # scala-steward PRs/branches
+ pull_request:
+ types: [opened, edited, synchronize, reopened]
+
+jobs:
+ enforce-checkbox:
+ runs-on: ubuntu-22.04
+ steps:
+ - name: Check required confirmation checkbox
+ uses: actions/github-script@v7
+ with:
+ script: |
+ const prBody = context.payload.pull_request.body || "";
+ const checkbox1Text = "- [x] I have determined that no
documentation updates are needed for these changes";
+ const checkbox2Text = "- [x] I have added following documentation
for these changes";
+
+ if (!prBody.includes(checkbox1Text) &&
!prBody.includes(checkbox2Text)) {
+ core.setFailed("❌ Required documentation checkbox not checked.
Please check one of the the box before merging.");
+ } else {
+ core.info("✅ Required documentation checkbox is checked.");
+ }
