Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add images to the description files. #23

Merged
merged 12 commits into from
Jan 3, 2023
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Added
- [#23](https://github.com/green-code-initiative/ecoCode/pull/23) Add images to the description files.

### Changed
- [#27](https://github.com/green-code-initiative/ecoCode/pull/27) Fix [WARNING] Maven-shade-plugin overlapping classes and upgrade SonarRuntime.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<p>Executing SQL queries in loop induced unnecessary calculation by the cpu, RAM usage and network transfert.</p>
<p>Executing SQL queries in loop induced unnecessary network transfert, calculation by the cpu and RAM usage.</p>
<h2>Noncompliant Code Example</h2>
<pre>
public function foo() {
Expand Down Expand Up @@ -42,3 +42,14 @@ <h2>Compliant Solution</h2>
}

</pre>

<h2>The three sources of impacts of a code identified are: </h2>
- Energy (measured in joules)
<br /> - Transfer (measured in Bytes)
<br /> - Storage (measured in Bytes)<br />
<br />The control of these 3 impacts allows to lengthen the life of the terminals as well as reduce their energy consumption.
<br />The ETSdiff tool allows to measure a differential on these three values and in a given context (database and fixed measurement environment).
<br />The results generated by ETSdiff must help define the interest of the rule reported by Sonarqube in the context of the code analyzed.
<br />
<img src="https://live.staticflickr.com/65535/52574863536_c912a1cc20_w.jpg"
alt="ETSdiff percent comparison" style="padding:2rem;">