Skip to content

Commit

Permalink
Update issue templates and CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Farhad-Shabani committed Jan 11, 2023
1 parent 59dd3d9 commit c131705
Show file tree
Hide file tree
Showing 7 changed files with 134 additions and 155 deletions.
24 changes: 8 additions & 16 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,20 @@ about: Create a report to help us squash bugs!
---

<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
v ✰ Thanks for opening an issue! ✰
v ✰ Thanks for opening an issue! ✰
v Before smashing the submit button please review the template.
v Please also ensure that this is not a duplicate issue :)
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -->

## Summary of Bug
## Summary of Issue

<!-- Describe the issue you're encountering -->
<!-- Apply relevant labels to indicate:
- (WHY) The purpose or objective of this issue with "O" labels
- (WHICH) The part of the system this issue relates to (use "E" for external or "I" for internal levels)
- (HOW) If any administrative considerations should be taken into account (use "A" labels)
This will help us prioritize and categorize your issue more effectively
-->

## Version

Expand All @@ -22,17 +28,3 @@ v Please also ensure that this is not a duplicate issue :)

<!-- What commands should someone run to reproduce your problem? -->
<!-- Attach logs here if you have them. -->

## Acceptance Criteria

<!-- What's the definition of "done" for this issue? -->

____

## For Admin Use

- [ ] Not duplicate issue
- [ ] Appropriate labels applied
- [ ] Appropriate milestone (priority) applied
- [ ] Appropriate contributors tagged
- [ ] Contributor assigned/self-assigned
23 changes: 11 additions & 12 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
name: Feature Request
about: Create a proposal to request a feature
about: Create a proposal to request a feature!

---

<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
v ✰ Thanks for opening an issue! ✰
v ✰ Thanks for opening an issue! ✰
v Before smashing the submit button please review the template.
v Word of caution: poorly thought-out proposals may be rejected
v without deliberation
Expand All @@ -14,28 +14,27 @@ v without deliberation
## Summary

<!-- Short description of the proposed feature -->
<!-- Apply relevant labels to indicate:
- (WHY) The purpose or objective of this issue with "O" labels
- (WHICH) The part of the system this issue relates to (use "E" for external or "I" for internal levels)
- (HOW) If any administrative considerations should be taken into account (use "A" labels)
-->

## Problem Definition
## Feature Definition

<!-- Why do we need this feature?
What problems may be addressed by introducing this feature?
What benefits does IBC-rs stand to gain by including this feature?
Are there any disadvantages of including this feature? -->

## Proposal

<!-- Detailed description of requirements of implementation -->

## Acceptance Criteria

<!-- What's the definition of "done" for this issue? -->
<!-- Break down the work into bullet points to better organize how things get done (If applicable) -->

____

#### For Admin Use
### For Admin Use

- [ ] Not duplicate issue
- [ ] Appropriate labels applied
- [ ] Appropriate milestone (priority) applied
- [ ] Appropriate contributors tagged
- [ ] Contributor assigned/self-assigned
- [ ] Appropriate contributors assigned
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/process-improvement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Process Improvement
about: Create a proposal to suggest an improvement for `ibc-rs` operations!

---

<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
v ✰ Thanks for opening an issue! ✰
v Before smashing the submit button please review the template.
v Please also ensure that this is not a duplicate issue :)
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -->

## Improvement Summary

<!-- Short description of the proposed improvement -->
<!-- Apply relevant labels to indicate:
- (WHY) The purpose or objective of this issue with "O" labels
- (WHICH) The part of the system this issue relates to (use "E" for external or "I" for internal levels)
- (HOW) If any administrative considerations should be taken into account (use "A" labels)
-->

## Definition

<!-- Why do we need this change?
What benefits does IBC-rs stand to gain by including this change?
Are there any disadvantages of including this change? -->

## Proposal

<!-- Describe your proposal for how the process of `ibc-rs` should be improved -->
<!-- Break down the work into bullet points to better organize how things get done (If applicable) -->


____

### For Admin Use

- [ ] Not duplicate issue
- [ ] Appropriate labels applied
- [ ] Appropriate contributors assigned
30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/release-template.md

This file was deleted.

25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/rust-update.md

This file was deleted.

Loading

0 comments on commit c131705

Please sign in to comment.