Skip to content

Commit 5e2b9b6

Browse files
authored
Update contributing guidelines for issue types
Clarify issue types and guidelines for proposals and bugs.
1 parent e63c445 commit 5e2b9b6

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

documentation/contributing.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,32 @@ to be moved to the next milestone.
7272
Opening a pull request without reaching out first might get rejected and eventually closed.
7373

7474
**🐛 Bug Fixes** - bug fixes are the only exception from the above rule. Bug Fixes can be opened directly without a proposal issue.
75+
Bug fix can should only carry fixes of existing code, additions (especially to our DSL) require a `Proposal` first.
7576

76-
## Before you start coding
77+
## Issue Types
78+
79+
Wondering which issue type to use? Please check below guideliness
80+
81+
### Proposal
82+
83+
- New feature request
84+
- Idea of changing/extending existing behavior
85+
- Something is missing and should be added
86+
- UX/DX improvements
87+
88+
### Bug
89+
90+
**Important** - please don't use `Bug` issue type for reporting missing features. `Bug` should be reported only against existing code that
91+
doesn't work as expected. When something is missing it requires a `Proposal` first.
92+
93+
- Incorrect behavior of an existing code
94+
- Performance degradation
95+
96+
### Task
97+
98+
- Those issues are meant to be used only by roadmap manager to split bigger items into smaller tasks
99+
100+
## Before coding
77101

78102
Please make sure that you are aware of our [Architecture Decision Records](/documentation/adrs.md).
79103
It's mandatory to follow all of them without any exceptions unless explicitly overridden by a new ADR.

0 commit comments

Comments
 (0)