GitHub: update templates

marcuspollio · marcuspollio · commit ce6a58606b36 · 2026-04-23T15:29:49.000+02:00
- Update PR and issues templates
- Minor markdown formatting in ReadMe
diff --git a/.github/ISSUE_TEMPLATE/1-BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/1-BUG_REPORT.yml
@@ -1,27 +1,30 @@
-name: "Bug report"
-description: "Report a problem to help improve the website project."
+name: Bug report
+description: Report a problem to help improve the website project.
 title: "Bug: <short description>"
 labels: Bug
 type: bug
+
 body:
   - type: markdown
     attributes:
       value: |
-        Thanks for taking the time to fill out this bug report! Please [search](https://github.com/freecad/website/issues) if a similar reported bug already exists. By submitting this issue, you accept the FreeCAD [Code of Conduct](https://github.com/FreeCAD/Website?tab=coc-ov-file#readme).
+        Thanks for taking the time to fill out this bug report! Please [search](https://github.com/freecad/website/issues) if a similar reported bug already exists.
+        This bug report template helps ensure issues can be reviewed and solved efficiently.
+        Please do not add 2 unrelated issues in a single report.
 
   - type: textarea
     id: description
     attributes:
-      label: Bug description?
-      description: Clear and concise description of the problem and how it impacts user experience, workflow or performance. Attach images or files by drag and dropping files in this area.
+      label: Bug description
+      description: Clear and concise description of the problem and how it impacts user experience, workflow or performance.
       placeholder: Describe the problem briefly.
     validations:
       required: true
 
   - type: dropdown
     id: dir
     attributes:
-      label: Page collection affected?
+      label: Page collection affected
       options:
         - Homepage
         - Features
@@ -37,7 +40,7 @@ body:
   - type: textarea
     id: reproduce
     attributes:
-      label: Steps to reproduce?
+      label: Steps to reproduce
       description: Provide a recipe to help reliably reproduce the issue.
       placeholder: |
         Steps to reproduce the behavior:
@@ -49,7 +52,7 @@ body:
   - type: textarea
     id: system
     attributes:
-      label: System affected?
+      label: System affected
       description: Provide basic info on the system affected by the issue.
       placeholder: |
         - Device: e.g. Desktop, Tablet, Smartphone
diff --git a/.github/ISSUE_TEMPLATE/2-FEATURE_REQUEST.yml b/.github/ISSUE_TEMPLATE/2-FEATURE_REQUEST.yml
@@ -1,27 +1,30 @@
-name: "Feature request"
-description: "Feature or improvement idea to help improve the website project."
+name: Feature request
+description: Feature or improvement idea to help improve the website project.
 title: "Feature: <short description>"
 labels: Feature
 type: feature
+
 body:
   - type: markdown
     attributes:
       value: |
-        Thanks for taking the time to fill out this feature request! Please [search](https://github.com/freecad/website/issues) if a similar requested feature already exists. By submitting this issue, you accept the FreeCAD [Code of Conduct](https://github.com/FreeCAD/Website?tab=coc-ov-file#readme).
+        Thanks for taking the time to fill out this feature request! Please [search](https://github.com/freecad/website/issues) if a similar requested feature already exists.
+        This feature request template helps ensure issues can be reviewed and solved efficiently.
+        Please do not add 2 unrelated issues in a single request.
 
   - type: textarea
     id: description
     attributes:
-      label: Feature description?
-      description: Clear and concise description of the feature or improvement idea and how it impacts user experience, workflow or performance. Attach images or files by drag and dropping files in this area.
+      label: Feature description
+      description: Clear and concise description of the feature or improvement idea and how it impacts user experience, workflow or performance.
       placeholder: Describe the feature briefly.
     validations:
       required: true
 
   - type: textarea
     id: implementation
     attributes:
-      label: Feature implementation?
+      label: Feature implementation
       description: Provide info how the feature can be implemented.
       placeholder: Describe the implementation briefly.
     validations:
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,4 +1,5 @@
 blank_issues_enabled: false
+
 contact_links:
   - name: 💬 START HERE - FreeCAD Forum
     url: https://forum.freecad.org/
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
diff --git a/.github/PULL_REQUEST_TEMPLATE/1-FEATURE.md b/.github/PULL_REQUEST_TEMPLATE/1-FEATURE.md
@@ -0,0 +1,48 @@
+## New feature or enhancement
+
+<!--
+Thanks for contributing to the FreeCAD community!
+This PR feature template helps ensure PRs can be reviewed efficiently.
+Please do not add 2 unrelated changes in a single PR.
+-->
+
+### Feature topic
+
+Pick appropriate topics:
+
+- Content
+- News
+- Homepage
+- Features
+- Download
+- Community
+- Docs
+- Donate
+- Theme
+- CSS
+- JS
+- Hugo
+- CMS
+- Config
+- Data
+- Assets
+- Static
+- Tools
+- GitHub
+
+### Feature summary and motivation
+
+Summarize why are these changes needed?
+
+### Changes description and implementation
+
+What was changed? How was it implemented? If the proposed changes affect the UI, add before and after screenshots.
+
+### Related issues
+
+Link to relevant Issues this PR resolves by referencing their number (e.g., fixes #1234, closes #4321) so it is closed automatically when this PR is merged.
+
+### PR checklist
+
+- [ ] This change is verified to work as described. The documentation is added/updated if necessary.
+- [ ] This change complies with the repository [Guidelines](https://github.com/FreeCAD/website?tab=readme-ov-file#guidelines).
diff --git a/.github/PULL_REQUEST_TEMPLATE/2-BUG.md b/.github/PULL_REQUEST_TEMPLATE/2-BUG.md
@@ -0,0 +1,44 @@
+## Bug fix
+
+<!--
+Thanks for contributing to the FreeCAD community!
+This PR bug template helps ensure PRs can be reviewed efficiently.
+Please do not add 2 unrelated changes in a single PR.
+-->
+
+### Bug fix topic
+
+Pick appropriate topics:
+
+- Content
+- News
+- Homepage
+- Features
+- Download
+- Community
+- Docs
+- Donate
+- Theme
+- CSS
+- JS
+- Hugo
+- CMS
+- Config
+- Data
+- Assets
+- Static
+- Tools
+- GitHub
+
+### Changes description and implementation
+
+What was changed? How was it implemented? If the proposed changes affect the UI, add before and after screenshots.
+
+### Related issues
+
+Link to relevant Issues this PR resolves by referencing their number (e.g., fixes #1234, closes #4321) so it is closed automatically when this PR is merged.
+
+### PR checklist
+
+- [ ] This change is verified to work as described. The documentation is added/updated if necessary.
+- [ ] This change complies with the repository [Guidelines](https://github.com/FreeCAD/website?tab=readme-ov-file#guidelines).
diff --git a/.github/PULL_REQUEST_TEMPLATE/3-NOTES.md b/.github/PULL_REQUEST_TEMPLATE/3-NOTES.md
@@ -0,0 +1,23 @@
+## Meeting and development notes
+
+<!--
+Thanks for contributing to the FreeCAD community!
+This PR notes template helps ensure PRs can be reviewed efficiently.
+Please do not add 2 unrelated changes in a single PR.
+-->
+
+### Botes topic
+
+Pick appropriate topics:
+
+- Meeting
+- Development
+
+### Notes content
+
+If the notes are for a specific meeting, please indicate the meeting date.
+
+### PR checklist
+
+- [ ] This change is verified to work as described. The documentation is added/updated if necessary.
+- [ ] This change complies with the repository [Guidelines](https://github.com/FreeCAD/website?tab=readme-ov-file#guidelines).
diff --git a/README.md b/README.md

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`blank_issues_enabled: false`
	`2`	`+`
`2`	`3`	`contact_links:`
`3`	`4`	`- name: 💬 START HERE - FreeCAD Forum`
`4`	`5`	`url: https://forum.freecad.org/`