From 34ec7eb593c6f92e2a2714ed92bab300a4f8862b Mon Sep 17 00:00:00 2001
From: u214892 <u214892@sbb.ch>
Date: Wed, 6 Nov 2019 11:23:43 -0500
Subject: [PATCH] #254 Technical Guidelines
---
.gitlab-ci.yml | 28 ++++------------------------
CONTRIBUTING.rst | 11 ++++++-----
2 files changed, 10 insertions(+), 29 deletions(-)
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 8aeb6fca..698ceca1 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -12,8 +12,7 @@ image: themattrix/tox
stages:
- tests
- integration_testing
- - profiling
- - benchmarks
+ - benchmarks_and_profiling
- deploy_docs
cache:
paths:
@@ -62,10 +61,10 @@ build_and_deploy_docs:
name: ${CI_COMMIT_REF_SLUG}
url: http://${BUCKET_NAME}.s3-website.${AWS_DEFAULT_REGION}.amazonaws.com/
-profiling:
+benchmarks_and_profiling:
dependencies:
- tests
- stage: profiling
+ stage: benchmarks_and_profiling
only:
variables:
- $BENCHMARKS_AND_PROFILING
@@ -79,26 +78,7 @@ profiling:
- conda update -n root conda -y
- conda install -c conda-forge tox-conda
script:
- - xvfb-run tox -e profiling -v --recreate
-
-benchmarks:
- dependencies:
- - tests
- stage: benchmarks
- only:
- variables:
- - $BENCHMARKS_AND_PROFILING
- before_script:
- - apt update
- - apt install -y libgl1-mesa-glx xvfb xdg-utils libcairo2-dev libjpeg-dev libgif-dev
- - wget -nv https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O /tmp/Miniconda3-latest-Linux-x86_64.sh
- - bash /tmp/Miniconda3-latest-Linux-x86_64.sh -b -p /tmp/miniconda3
- - export PATH=/tmp/miniconda3/bin:$PATH
- - pip install tox awscli
- - conda update -n root conda -y
- - conda install -c conda-forge tox-conda
- script:
- - xvfb-run tox -e benchmarks -v --recreate
+ - xvfb-run tox -e benchmarks,profiling -v --recreate
test_conda_setup:
stage: integration_testing
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 360d3167..f149853f 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -108,21 +108,22 @@ Merge Request Guidelines
Before you submit a merge request, check that it meets these guidelines:
1. The merge request should include tests.
-2. If the merge request adds functionality, the docs should be updated. Put
+2. The could must be formatted (PyCharm)
+3. If the merge request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
-3. The merge request should work for Python 3.6, 3.7 and for PyPy. Check
+4. The merge request should work for Python 3.6, 3.7 and for PyPy. Check
https://gitlab.aicrowd.com/flatland/flatland/pipelines
and make sure that the tests pass for all supported Python versions.
We force pipelines to be run successfully for merge requests to be merged.
-4. Although we cannot enforce it technically, we ask for merge requests to be reviewed by at least one core member
+5. Although we cannot enforce it technically, we ask for merge requests to be reviewed by at least one core member
in order to ensure that the Technical Guidelines below are respected and that the code is well tested:
-4.1 The remarks from the review should be resolved/implemented and communicated using the 'discussions resolved':
+5.1. The remarks from the review should be resolved/implemented and communicated using the 'discussions resolved':
.. image:: images/DiscussionsResolved.png
-4.2 When a merge request is merged, source branches should be deleted and commits squashed:
+5.2. When a merge request is merged, source branches should be deleted and commits squashed:
.. image:: images/SourceBranchSquash.png
--
GitLab