mirror of
https://github.com/SpartanJ/eepp.git
synced 2026-10-01 10:40:20 +03:00
ecode: Enable line-wrap by default on new installations.
Added Code of Conduct and Contributing documents. Added templates for bug reports and feature requests.
This commit is contained in:
@@ -0,0 +1,117 @@
|
||||
name: Bug report
|
||||
description: Report a reproducible problem in a project or component
|
||||
title: "[Bug]: "
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for taking the time to report a problem.
|
||||
|
||||
Use this form only for observable bugs. Questions, troubleshooting, and uncertain reports belong in [Discussions](https://github.com/SpartanJ/eepp/discussions). Please read the [contribution guidelines](../../CONTRIBUTING.md) before continuing.
|
||||
|
||||
- type: checkboxes
|
||||
id: preliminary-checks
|
||||
attributes:
|
||||
label: Preliminary checks
|
||||
options:
|
||||
- label: I searched existing Issues and Discussions and did not find a duplicate.
|
||||
required: true
|
||||
- label: This is an observable defect, not only a preference or support question.
|
||||
required: true
|
||||
- label: I have personally reviewed this report and verified that its contents are accurate.
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: project
|
||||
attributes:
|
||||
label: Affected project or component
|
||||
description: Identify the application, library, tool, module, or component where the problem occurs.
|
||||
placeholder: e.g. ecode editor, UI module, network module
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: observed-behavior
|
||||
attributes:
|
||||
label: Observed behavior
|
||||
description: Describe precisely what happened, including any visible error or incorrect result.
|
||||
placeholder: Describe the concrete behavior you observed.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected-behavior
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
description: Explain what should have happened and why.
|
||||
placeholder: Describe the expected result.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: reproduction
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: Provide exact, minimal steps that another person can follow. Include a minimal example when possible.
|
||||
placeholder: |
|
||||
1. Start with...
|
||||
2. Configure or open...
|
||||
3. Perform...
|
||||
4. Observe...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: environment
|
||||
attributes:
|
||||
label: Environment
|
||||
description: Provide all details relevant to reproducing the problem.
|
||||
value: |
|
||||
- Project version, commit, or build date:
|
||||
- Operating system and version:
|
||||
- Architecture:
|
||||
- Compiler and version, if relevant:
|
||||
- Graphics backend, if relevant:
|
||||
- Other relevant details:
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: reproducibility
|
||||
attributes:
|
||||
label: Reproducibility
|
||||
description: How consistently can you reproduce the problem?
|
||||
options:
|
||||
- Every time
|
||||
- Frequently
|
||||
- Occasionally
|
||||
- Only once
|
||||
- Unable to reproduce again
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: evidence
|
||||
attributes:
|
||||
label: Evidence
|
||||
description: Provide relevant logs, complete error messages, crash stack traces, screenshots, or recordings. If evidence is unavailable, explain why. You can drag files into this field.
|
||||
placeholder: Paste evidence, attach files, or explain why it cannot be provided.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: Include previous working versions, possible causes, workarounds, related links, or anything else that may help.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: Submission agreement
|
||||
options:
|
||||
- label: I will provide reasonably requested information and follow the [Code of Conduct](../../CODE_OF_CONDUCT.md).
|
||||
required: true
|
||||
|
||||
@@ -0,0 +1,84 @@
|
||||
name: Feature request
|
||||
description: Propose a specific, well-defined improvement
|
||||
title: "[FR]: "
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Well-defined feature requests are welcome. Early-stage or broad ideas should be posted in the [Ideas discussion category](https://github.com/SpartanJ/eepp/discussions/categories/ideas) first. Starting a Discussion before a large or consequential request is encouraged.
|
||||
|
||||
Please read the [contribution guidelines](../../CONTRIBUTING.md) before continuing.
|
||||
|
||||
- type: checkboxes
|
||||
id: preliminary-checks
|
||||
attributes:
|
||||
label: Preliminary checks
|
||||
options:
|
||||
- label: I searched existing Issues and Discussions and did not find a duplicate.
|
||||
required: true
|
||||
- label: This request is sufficiently defined to be evaluated and acted upon.
|
||||
required: true
|
||||
- label: I have personally reviewed this request and verified that its contents are accurate.
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: project
|
||||
attributes:
|
||||
label: Affected project or component
|
||||
description: Identify the application, library, tool, module, or component this request concerns.
|
||||
placeholder: e.g. ecode editor, UI module, network module
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: Problem or use case
|
||||
description: Describe the concrete problem, limitation, or use case. Explain who benefits and under what conditions.
|
||||
placeholder: What problem needs to be solved, and for whom?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: proposed-behavior
|
||||
attributes:
|
||||
label: Proposed behavior
|
||||
description: Describe the desired outcome precisely. Include examples where useful.
|
||||
placeholder: What should the project do?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: constraints
|
||||
attributes:
|
||||
label: Constraints and alternatives
|
||||
description: Describe relevant technical constraints, tradeoffs, alternative solutions, and existing workarounds.
|
||||
placeholder: What alternatives have you considered?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: discussion
|
||||
attributes:
|
||||
label: Related Discussion
|
||||
description: If this proposal was discussed first, link the Discussion here.
|
||||
placeholder: https://github.com/SpartanJ/eepp/discussions/...
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: Add mockups, examples, references, or other information that helps evaluate the request.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: Submission agreement
|
||||
options:
|
||||
- label: I understand that submitting a request does not commit maintainers to implementing it, and I agree to follow the [Code of Conduct](../../CODE_OF_CONDUCT.md).
|
||||
required: true
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Questions and support
|
||||
url: https://github.com/SpartanJ/eepp/discussions
|
||||
about: Ask project-related questions and request troubleshooting help in Discussions.
|
||||
- name: Ideas and early proposals
|
||||
url: https://github.com/SpartanJ/eepp/discussions/categories/ideas
|
||||
about: Share ideas that are not yet specific enough to be actionable Issues.
|
||||
Reference in New Issue
Block a user