Skip to content

Commit

Permalink
Merge pull request #183 from EPFL-ENAC/doc-ci-pre-commit
Browse files Browse the repository at this point in the history 
Upadate documentation
  • Loading branch information
@regislon
regislon authored May 8, 2023
2 parents 6a89111 + 4b549de commit 76da654
Show file tree
Hide file tree
Showing 8 changed files with 70 additions and 95 deletions.
46 changes: 22 additions & 24 deletions CONTRIBUTING.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -307,17 +307,17 @@ To run Ruff locally :
In the table below, some CI tool are mentioned for your information, but does not need to be installed on your computer. They are automatically run when you push your changes to the main repository via a GitHub Pull Request.


+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+------------+-------+-------------------------------------------+
| Tool | Aim | pre-commit | CI/CD | Python version |
+===============================================================================================+==================================================================+============+=======+===========================================+
| `pre-commit.ci <https://pre-commit.ci/>`__ | Run pre-commit (as defined in `.pre-commit-config.yaml` ) | | 👍 | |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+------------+-------+-------------------------------------------+
| `CodeBeat <https://codebeat.co/>`__ | Automated code review and analysis tools | - | 👍 | all versions according to GitHub workflow |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+------------+-------+-------------------------------------------+
| `CodeScene <https://codescene.com/>`__ | Automated code review and analysis tools | - | 👍 | ? |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+------------+-------+-------------------------------------------+
| `CodeFactor <https://www.codefactor.io/>`__ | Automated code review and analysis tools | - | 👍 | ? |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+------------+-------+-------------------------------------------+
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+-------------------------------------------+
| Tool | Aim | Python version |
+===============================================================================================+==================================================================+===========================================+
| `pre-commit.ci <https://pre-commit.ci/>`__ | Run pre-commit (as defined in `.pre-commit-config.yaml` ) | |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+-------------------------------------------+
| `CodeBeat <https://codebeat.co/>`__ | Automated code review and analysis tools | all versions according to GitHub workflow |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+-------------------------------------------+
| `CodeScene <https://codescene.com/>`__ | Automated code review and analysis tools | ? |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+-------------------------------------------+
| `CodeFactor <https://www.codefactor.io/>`__ | Automated code review and analysis tools | ? |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+-------------------------------------------+



Expand Down Expand Up @@ -379,17 +379,17 @@ The reader test succeeds if both files (ground truth and transformation of the r
The Continuous Integration (CI) on GitHub runs tests and analyzes code coverage. The following tools are used:


+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+------------+-------+-------------------------------------------+
| Tool | Aim | pre-commit | CI/CD | Version |
+===============================================================================================+==================================================================+============+=======+===========================================+
| `Pytest <https://docs.pytest.org>`__ | Execute unit tests and functional tests | - | 👍 | |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+------------+-------+-------------------------------------------+
| Coverage | Measure the code coverage of the project's unit tests | - | 👍 | all versions according to GitHub workflow |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+------------+-------+-------------------------------------------+
| `CodeCov <https://about.codecov.io/>`__ | Uses the "coverage" package to generate a code coverage report. | - | 👍 | all versions according to GitHub workflow |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+------------+-------+-------------------------------------------+
| `Coveralls <https://coveralls.io/>`__ | Uses the "coverage" to track the quality of your code over time. | - | 👍 | all versions according to GitHub workflow |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+------------+-------+-------------------------------------------+
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+-------------------------------------------+
| Tool | Aim | Version |
+===============================================================================================+==================================================================+===========================================+
| `Pytest <https://docs.pytest.org>`__ | Execute unit tests and functional tests | |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+-------------------------------------------+
| Coverage | Measure the code coverage of the project's unit tests | all versions according to GitHub workflow |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+-------------------------------------------+
| `CodeCov <https://about.codecov.io/>`__ | Uses the "coverage" package to generate a code coverage report. | all versions according to GitHub workflow |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+-------------------------------------------+
| `Coveralls <https://coveralls.io/>`__ | Uses the "coverage" to track the quality of your code over time. | all versions according to GitHub workflow |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+-------------------------------------------+



Expand Down Expand Up @@ -426,8 +426,6 @@ a Pull Request (PR) to the DISDRODB main branch.
- Add screenshots or GIFs for any UI changes. This will help the person reviewing your code to understand what you’ve changed and how it
works.

- *Hint: use * \ `Kap <https://getkap.co/>`__\ * or * \ `Licecap <https://www.cockos.com/licecap/>`__\ * to record your screen.*

- Please use the pertinent template for the pull request, and fill it out accurately.

- It’s OK to have multiple small commits as you work on the PR - GitHub
Expand Down
2 changes: 1 addition & 1 deletion docs/source/maintainers_guidelines.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Currently, on each Pull Request, GitHub Actions are configured as follow:


+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------+
| | Aim | Status | Python version |
| Tools | Aim | Project page | Python version |
+====================================================================================================+==================================================================+==============================================================================================+===========================================+
| `Pytest <https://docs.pytest.org>`__ | Execute unit tests and functional tests | | |
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------------+
Expand Down
16 changes: 8 additions & 8 deletions docs/source/metadata_csv/Deployment_Info.csv
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Keys, Description
latitude, WGS84 latitude in degree north [-90,90]. If the disdrometer is moving, specify -9999
longitude, WGS84 longitude in degree east [-180,180]. If the disdrometer is moving, specify -9999
altitude, Elevation above the sea level in meters. If the disdrometer is moving, specify -9999
deployment_status, Deployment status. Possible values: 'terminated' or 'ongoing'
deployment_mode, Deployment mode. Possible values: 'land', 'ship', 'truck', 'cable'
platform_type, Platform type. Possible values: ' fixed' or 'mobile'
platform_protection, Platform protection. Possible values: 'N/A', 'shielded', 'unshielded’
platform_orientation, Platform orientation in 0-360 degrees from the North direction (clockwise)
latitude, "WGS84 latitude in degree north [-90,90]. If the disdrometer is moving, specify -9999"
longitude, "WGS84 longitude in degree east [-180,180]. If the disdrometer is moving, specify -9999"
altitude, "Elevation above the sea level in meters. If the disdrometer is moving, specify -9999"
deployment_status, "Deployment status. Possible values: 'terminated' or 'ongoing'"
deployment_mode, "Deployment mode. Possible values: 'land', 'ship', 'truck', 'cable'"
platform_type, "Platform type. Possible values: ' fixed' or 'mobile'"
platform_protection, "Platform protection. Possible values: 'N/A', 'shielded', 'unshielded’"
platform_orientation, "Platform orientation in 0-360 degrees from the North direction (clockwise)"
2 changes: 1 addition & 1 deletion docs/source/metadata_csv/Description.csv
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ summary, Summary information of the station
comment, Comment on the station measurements
history, History of the raw data file
station_id,ID of the station
location, Village, town or region where the disdrometer is located
location, "Village, town or region where the disdrometer is located"
country, Country where the disdrometer is located
continent,Continent where the disdrometer is located
2 changes: 1 addition & 1 deletion docs/source/metadata_csv/Sensor_Info.csv
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Keys, Description
sensor_long_name, Sensor long name
sensor_manufacturer, Sensor manufacturer. Examples: Thies Clima, OTT Hydromet, Vaisala, Campbell, …
sensor_manufacturer, "Sensor manufacturer. Examples: Thies Clima, OTT Hydromet, Vaisala, Campbell, …"
sensor_wavelength, Sensor wavelength
sensor_serial_number, Sensor serial number
firmware_iop, TO BE DEFINED [Available for OTT Parsivels]
Expand Down
2 changes: 1 addition & 1 deletion docs/source/metadata_csv/Source_Info.csv
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Keys, Description
source, Source information
source_convention, Raw data file convention (i.e. ARM v1.XXX, NASA v1.XX, …)
source_convention, "Raw data file convention (i.e. ARM v1.XXX, NASA v1.XX, …)"
source_processing_date, Date of source raw data file creation
Loading

0 comments on commit 76da654

Please sign in to comment.