Skip to content

Commit eed922e

Browse files
committed
further improvements to the Features page
1 parent b62a381 commit eed922e

8 files changed

+26
-20
lines changed

assets/grouping-developer.gif

-1.91 MB
Binary file not shown.

assets/grouping-louvain.gif

-3 MB
Binary file not shown.

assets/grouping.gif

36.3 MB
Loading

assets/landing-comments.png

2.69 MB
Loading

assets/query-by-rule.png

2.5 MB
Loading

assets/reviewer-recommendation.png

330 KB
Loading

features.html

+23-17
Original file line numberDiff line numberDiff line change
@@ -28,43 +28,49 @@ <h1>Features</h1>
2828
gain insight into the development process and improve it <a href="#1">[1]</a>.</p>
2929

3030
<h2>Initial artifact traceability graph of interest</h2>
31+
<p>Assuming they agreed to create landing comments, users may initiate their analysis through the links in
32+
the associated comment of an issue tracking tool such as GitHub or Jira.
33+
<img src="assets/landing-comments.png" alt="Launching SAA from a comment">
34+
</p>
35+
<p>Alternatively, a user may launch SAA with a specific artifact or developer in the URL. For instance,
36+
<code>http://saa.cs.bilkent.edu.tr/?name=ANY23-245</code>
37+
launches SAA with <b>the issue named ANY23-245 and other artifacts/developers that it is directly in relation
38+
with</b>.
39+
</p>
40+
<p>Furthermore, SAA may be started with an empty drawing canvas and a query may be constructed.
41+
A query might be an SQL-like query (e.g., all issues with a type of bug and
42+
priority of equal) or a more advanced graph-based query (e.g., any files that developers all A, B and C
43+
contributed to).
44+
</p>
45+
<img width="70%" src="assets/query-by-rule.png" alt="Composing and executing a query by rule">
3146
<div class="flex-container">
3247
<div class="flex_text_container">
33-
<p>The user may initiate their analysis either through an issue tracking tool such as GitHub and Jira or directly
34-
launch SAA and construct a query. A query might be an SQL-like query (e.g., all issues with a type of bug and
35-
priority of equal) or a more advanced graph-based query (e.g., any files that developers all A, B and C
36-
contributed to).
37-
</p>
38-
<p>This basically forms a "landing" artifact traceability graph of interest, which may be further extended
48+
<p>Once a "landing" artifact traceability graph of interest is somehow formed, it may be further extended
3949
through additional queries or via context menus of artifacts in the graph.
4050
</p>
4151
<p>The context menus are specific to each node type, allowing users to perform operations tailored to that specific
4252
software artifact or developer. For instance, one might be interested in finding <b>any source code files
4353
modified by a particular pull request</b>, followed by <b>author(s) of the related commit</b> from the context menu of that pull request as exemplified below.
4454
</p>
4555
</div>
46-
<div class="flex_text_img_separator"></div>
56+
<div class="flex_separator"></div>
4757
<div class="flex_img_container">
48-
<img src="assets/context-menus.gif" alt="Context Menu">
58+
<img src="assets/context-menus.gif" alt="Context menus">
4959
</div>
5060
</div>
5161
<h2>Inspecting graph content</h2>
5262
<p>By selecting an artifact or developer or a relation among them, you may get detailed information about that entity
5363
or the relationship through object inspectors. When applicable, the inspector will link the artifact to associated
5464
any GitHub or Jira page.
55-
<img width="70%" src="assets/inspector.png" alt="Object Inspector">
65+
<img width="70%" src="assets/inspector.png" alt="Object inspector">
5666
</p>
5767

5868
<h2>Complexity management through grouping</h2>
5969
<p>SAA facilitates the grouping of nodes either manually or automatically based on topology or developers,
6070
enhancing analysis and reducing complexity. Below is an example of a traceability graph grouped by developer.
6171
</p>
6272

63-
<div>
64-
<img width="45%" src="assets/grouping-developer.gif" style="display:inline-block" alt="Grouping by Developer">
65-
<img width="6%" style="display:inline-block"/>
66-
<img width="45%" src="assets/grouping-louvain.gif" style="display:inline-block" alt="Grouping by Topology (Louvain Clustering)">
67-
</div>
73+
<img width="60%" src="assets/grouping.gif" alt="Grouping by developer or topology (Louvain clustering)">
6874

6975
<p>SAA hosts some readily available software analytic methods described below to illustrate how such methods may be
7076
integrated into the framework quickly.
@@ -73,7 +79,7 @@ <h2>Complexity management through grouping</h2>
7379
<h2>Reviewer recommendation</h2>
7480
<p>Utilizing the RSTrace+ algorithm <a href="#2">[2]</a>, SAA assists in making reviewer assignments, offering
7581
a visual representation of analysis results to boost confidence in decision-making.
76-
<img width="70%" src="assets/reviewer-recommendation.png" alt="Reviewer Recommendation">
82+
<img width="74%" src="assets/reviewer-recommendation.png" alt="Reviewer recommendation">
7783
</p>
7884

7985
<p>Users can customize their view by choosing the number of recommendations to display and incorporating a recency
@@ -90,7 +96,7 @@ <h2>Expert recommendation</h2>
9096
<h2>Bug tracking process anomaly detection</h2>
9197
<p>SAA detects a high number of types of bug-tracking process anomalies, as categorized by Qamar et al.
9298
in <a href="#3">[3]</a>, contributing to process evaluation and anomaly prevention.
93-
<img width=70% src="assets/anomaly-detection.png" alt="Anomaly Detection">
99+
<img width=70% src="assets/anomaly-detection.png" alt="Anomaly detection">
94100
</p>
95101
<p>Visual cues on each issue aid in quickly identifying issues with higher number of anomalies, with the tooltips
96102
summarizing the type of anomalies detected.
@@ -100,7 +106,7 @@ <h2>Integration with issue tracking tools</h2>
100106
<p>SAA allows users to report analysis results or observations directly on GitHub or Jira platforms, promoting seamless
101107
integration and practicality. Users can submit reports as comments under <i>pull requests</i> in GitHub or
102108
as comments under <i>issues</i> in Jira, enhancing collaboration and communication.
103-
<img width=70% src="assets/reporting.png" alt="Report Component">
109+
<img width=70% src="assets/reporting.png" alt="Reporting component">
104110
</p>
105111
<p>This empowers developers with the ability to detect anomalies, make informed decisions, and collaborate effectively within the context of their software projects.</p>
106112

style.css

+3-3
Original file line numberDiff line numberDiff line change
@@ -191,15 +191,15 @@ justify-content: center;
191191
}
192192

193193
.flex_text_container {
194-
width: 44%;
194+
width: 50%;
195195
}
196196

197-
.flex_text_img_separator {
197+
.flex_separator {
198198
width: 14%;
199199
}
200200

201201
.flex_img_container {
202-
width: 42%;
202+
width: 46%;
203203
}
204204

205205
.card {

0 commit comments

Comments
 (0)