💻 Bring your own computer (personal or your company computer). In case of bringing your compagny, please be aware of the restrictions of your company : ne work, install, setings... in order to develop and participate to the challenge
🎧 Bring also your accessories : Earphones, Headphones, power supply (computer and mobile), vga/hdmi adapters
🔥 Try to start one of the two projects (https://github.com/green-code-initiative/ecoCode or https://github.com/green-code-initiative/ecoCode-mobile) in your local environment that you will bring for the challenge in order to check if everything work as expected by following the "Local development" procedure
❔ If you have issues to install and prepare your environment, please create a github issue : https://github.com/green-code-initiative/ecoCode-common/issues
Method 1 - Execute script verification (present in the repository https://github.com/green-code-initiative/ecoCode-common in tools/check_requirements/ directory) :
For Mac or Unix OS : ./check_requirements.sh
For Windows OS :
- execute following script :
./check_requirements.bat - then check versions displayed
Method 2 - Check manually your tools :
- install Docker : https://docs.docker.com/get-docker/
- Docker-compose 3.9 : https://docs.docker.com/compose/install/
- Java >=11 for Sonarqube plugin Development : https://www.java.com/fr/download/manual.jsp
- Maven 3 for Sonarqube plugin Development : https://maven.apache.org/download.cgi
- Git : https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
Then launch check commands as follows (and check versions displayed) :
docker --version
docker-compose --version
javap -version
mvn --version
git --version
Clone the project with (standard, mobile or/and common) :
git clone https://github.com/green-code-initiative/ecoCode
git clone https://github.com/green-code-initiative/ecoCode-mobile
git clone https://github.com/green-code-initiative/ecoCode-common
You will find all the steps to start a Sonarqube dev Environment here :
- standard : https://github.com/green-code-initiative/ecoCode/blob/main/INSTALL.md
- mobile : https://github.com/green-code-initiative/ecoCode-mobile/blob/main/INSTALL.md
Choose a rule in a specific language in the "To do" column : https://github.com/cnumr/ecoCode/projects/1 and move it to the "In progress"
Each rule needs to have scripts in a specific language (i.e. Python, Rust, JS, PHP and JAVA) in order to test directly inside Sonarqube that the rule has been implemented.
To validate that the rule has been implemented, you need to execute a scan on those scripts. You will need sonar scanner: https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/
In order to develop a Sonarqube Plugin in Open source for ecocode, two basics must have been mastered:
- How to develop a Sonarqube plugin
- Understand and work withe the Gitflow
https://docs.sonarqube.org/latest/extend/developing-plugin/
https://medium.com/android-news/gitflow-with-github-c675aa4f606a
- standard part : https://github.com/green-code-initiative/ecoCode
- mobile part : https://github.com/green-code-initiative/ecoCode-mobile
- common part (doc / tools) : https://github.com/green-code-initiative/ecoCode-common
https://collectif.greenit.fr/ecoconception-web/115-bonnes-pratiques-eco-conception_web.html
If you don't understand what a rule means, take a look at the link above. Mouse over in order to have more details.
https://olegoaer.perso.univ-pau.fr/android-energy-smells/
Create a new branch following this pattern : <rule_id>- Example :
git checkout -b 47-JS
Commit your code :
git add .
git commit -m "your comments"
Push your branch :
git push origin <rule_id>-<language>
You may have to log with your account : https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
Once your code is pushed and tested, open a PR between your branch and "main" : https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
Ask to people to review your PR. Once two people, at least, have reviewed, you can validate your PR If you want to be reviewed, review others... It's a win/win situation
Validate your PR or ask to someone who have the permissions to validate your PR. Once PR validated, a github workflow is automatically launched. Thus, the new implemented code is also scan with our internal Sonar to check the implemented code quality. Here is the SonarQube : https://sonarcloud.io/organizations/green-code-initiative/projects
Builders : https://github.com/green-code-initiative/ecoCode-challenge/blob/main/builders.md
Spotters : https://github.com/green-code-initiative/ecoCode-challenge/blob/main/builders.md