Skip to content

Commit

Permalink
Merge pull request #458 from Anastasia-Labs/issues-template
Browse files Browse the repository at this point in the history
chores: repository workflows for issues & pull requests
  • Loading branch information
solidsnakedev authored Dec 19, 2024
2 parents 4a3db6b + 4e7769e commit ff78e56
Show file tree
Hide file tree
Showing 7 changed files with 162 additions and 0 deletions.
76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: 🐛 Bug Report
description: Report an issue with Lucid Evolution
labels: ['bug']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to make Lucid Evolution more robust!
# 🔍 Bug Report Details
> Please fill out the information below carefully
---
**Note:** The more information you provide, the faster we can help.
- ✅ Thorough reports get resolved faster
- ❌ Incomplete reports may be closed
- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue also mention it in the description.
placeholder: Bug description
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction
description: Please provide a minimal reproduction of the issue. If a report is vague, it will be marked as "needs-info".
placeholder: |
```
// Your minimal reproduction code here
const lucid = ...
```
validations:
required: true
- type: textarea
id: system-info
attributes:
label: Error Details
description: |
Please provide:
- Lucid Evolution version (check your package.json)
- Terminal logs/error messages
render: shell
placeholder: Paste your error logs here
validations:
required: true
- type: dropdown
id: network
attributes:
label: Cardano Network
description: Which Cardano network are you using?
options:
- Mainnet
- Preprod
- Preview
- Custom
validations:
required: true
- type: checkboxes
id: checkboxes
attributes:
label: Validations
description: Before submitting the issue, please make sure you do the following
options:
- label: Read the [Documentation](https://anastasia-labs.github.io/lucid-evolution/)
required: true
- label: Check that there isn't already an [issue](https://github.com/Anastasia-Labs/lucid-evolution/issues) that reports the same bug to avoid creating a duplicate
required: true
- label: The provided reproduction is a [minimal reproducible](https://stackoverflow.com/help/minimal-reproducible-example) example of the bug
required: true
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
blank_issues_enabled: false
contact_links:
- name: 📚 Documentation
url: https://anastasia-labs.github.io/lucid-evolution/
about: Check the documentation first - your question might already be answered

- name: ❓ Questions about using Lucid Evolution
url: https://github.com/Anastasia-Labs/lucid-evolution/discussions/categories/q-a
about: Please ask and answer questions in GitHub Discussions under Q&A category

- name: 💭 Feature Ideas & Suggestions
url: https://github.com/Anastasia-Labs/lucid-evolution/discussions/categories/ideas
about: Share ideas and suggestions in GitHub Discussions under Ideas category

- name: 💬 Community Chat
url: https://discord.gg/KCeEjr94DG
about: For quick questions and community chat, join our Discord server
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: 💡 New feature request
description: Propose new feature to be added to Lucid Evolution
labels: ['feature-request']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request for Lucid Evolution.
- type: textarea
id: feature-description
attributes:
label: Clear and concise description of your idea
description: 'As a developer using Lucid Evolution I would like to [goal / wish] so that [benefit].'
validations:
required: true
- type: textarea
id: suggested-solution
attributes:
label: Suggested solution
description: How could this feature be implemented?
placeholder: |
```typescript
const tx = await lucid
.newTx()
.yourNewFeature({
// Your proposed implementation
})
```
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Any other context or screenshots about the feature request here.
- type: checkboxes
id: checkboxes
attributes:
label: Validations
description: Before submitting the issue, please make sure you do the following
options:
- label: Read the [Documentation](https://anastasia-labs.github.io/lucid-evolution/documentation/core-concepts/instantiate-evolution)
required: true
- label: Read the [Contributing Guidelines](https://github.com/Anastasia-Labs/lucid-evolution/blob/main/CONTRIBUTING.md)
required: true
- label: Check that there isn't already an issue that requests the same feature to avoid creating a duplicate
required: true
24 changes: 24 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Description

<!-- Please include a summary of the changes and which issue is being fixed. -->

Fixes # (issue)

## Type of change

- [ ] 🔧 Bug fix
- [ ] 💡 New feature
- [ ] 🔩 Performance improvement
- [ ] 📚 Docs

If the feature is substantial or introduces breaking changes without a discussion, its best to open an [issue](https://github.com/Anastasia-Labs/lucid-evolution/issues) first.

## Checklist

- [ ] I commented my code
- [ ] Added/modified unit tests
- [ ] I made corresponding changes to the documentation

## Additional Notes

<!-- Any additional information we should know? -->
Binary file removed assets/images/governance-benchmark.gif
Binary file not shown.
Binary file removed assets/images/governance.gif
Binary file not shown.
Binary file removed assets/images/tests.gif
Binary file not shown.

0 comments on commit ff78e56

Please sign in to comment.