Skip to content

Commit a0dec89

Browse files
Added Feature or Bug page
1 parent 15803db commit a0dec89

File tree

2 files changed

+43
-1
lines changed

2 files changed

+43
-1
lines changed

docs/package-wizard.tree

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
name="Package Wizard"
77
start-page="introduction.topic">
88

9-
<toc-element topic="introduction.topic" />
9+
<toc-element topic="introduction.topic" >
10+
<toc-element topic="feature-or-bug.topic" />
11+
</toc-element>
1012
<toc-element topic="installation.topic" />
1113
<toc-element topic="usage.topic" />
1214
<toc-element topic="development.topic" >

docs/topics/feature-or-bug.topic

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic
3+
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
4+
<topic
5+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6+
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
7+
title="Is it a feature or a bug ?" id="feature-or-bug">
8+
9+
<title>Feature or Bug</title>
10+
11+
<tip>
12+
Sometimes it's a bit tricky to define if given change proposal or change request is adding new feature or fixing existing issue. This document is providing more clarity about categorisation we use.
13+
</tip>
14+
15+
<chapter title="Bug" id="bug">
16+
<p>
17+
Example of bugs:
18+
</p>
19+
20+
21+
<list>
22+
<li>crash during application or rule execution</li>
23+
<li>wrong changes are applied during "fixing codebase" process</li>
24+
<li>issue with generated report</li>
25+
</list>
26+
</chapter>
27+
28+
<chapter title="Feature" id="feature">
29+
<p>
30+
Example of features:
31+
</p>
32+
33+
<list>
34+
<li>introduction of new rule</li>
35+
<li>enhancement of existing rule to cover more cases (for example adding support for newly introduced PHP syntax)</li>
36+
<li>introduction of new ruleset</li>
37+
<li>update of existing ruleset (for example adjusting it to match newest style of given community or adding newly implemented rule that was supposed to be followed by style of given community, yet not implemented as a rule before)</li>
38+
</list>
39+
</chapter>
40+
</topic>

0 commit comments

Comments
 (0)