Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add formula request template to issue tracker #446

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
blank_issues_enabled: false
contact_links:
- name: '💬 Contact one of the maintainers'
url: https://github.com/Blueprints-org/blueprints/people
url: https://github.com/Blueprints-org/blueprints/blob/main/CONTRIBUTING.md#contact
about: '💬 Contact one of the maintainers'
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/formula_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: '🔧 Formula Request'
description: Suggest a new formula to be implemented for Blueprints
title: "[🔧 Formula Request]: Add formulas from chapter XXX from Eurocode YYY."
labels: [ enhancement ]

body:
- type: markdown
attributes:
value: "## Blueprints Formula Request Template"

- type: textarea
id: formula-description
attributes:
label: "Formula Description"
description: "Describe the formula you're suggesting to add."
placeholder: "Add equation XXX to YYY from Eurocode ZZZ to the project."
validations:
required: true

- type: textarea
id: formula-acceptance-criteria
attributes:
label: "Acceptance Criteria"
description: "List the conditions that the formula must fulfill to be considered complete."
placeholder: "- [ ] Add the formula to the code\n- [ ] Add latex expression to the formula\n- [ ] Add unittests\n- "
"[ ] Add docstrings\n- [ ] Update table in docs with classname(s)"
validations:
required: true

- type: textarea
id: formula-dependencies
attributes:
label: "Dependencies"
description: "List any dependencies, like third-party libraries or specific hardware, needed for this formula."
placeholder: ""
validations:
required: false

- type: checkboxes
id: confirm
attributes:
label: "Confirmation"
options:
- label: "I have checked that this formula does not already exist in the issue tracker."
- label: "I have read and understood the contribution guidelines."
validations:
required: true