Merge pull request #9 from valentingol/dev

🧑‍💻 Developement update and config file saved automatically

CONTRIBUTE.md

@@ -1,6 +1,34 @@
-# How to contribute
+# Contributing to GAN Facies Modeling
 
-## Commit message
+Everyone can contribute to GAN Facies Modeling, and we value everyone’s contributions. There are several ways to contribute, including:
+
+- Raising [issue](https://github.com/valentingol/my_workflow_template/issues) on the Github repository
+
+- Proposing [Pull requests](https://github.com/valentingol/my_workflow_template/pulls) to the Github repository
+
+- Contact me by email ([email protected])
+
+- Create your own repository based on this one and cite it
+
+## Pull request checklist
+
+Before proposing a PR you must follow some rule:
+
+- Code should work on Python 3.8-3.10
+
+- Code should respect [PEP8](https://peps.python.org/pep-0008/)
+
+- The format of the docstrings follows [Numpy guidline](https://numpydoc.readthedocs.io/en/latest/format.html)
+
+**IMPORTANT: Before submitting a PR you should run the following command:**
+
+```script
+sh tests/basic_checks.sh
+```
+
+This script run all the unit tests and use the following linter: `mypy` (typing checks), `isort` (import order checks), `pydocstyle` (docstrings checks), `flake8` (PEP8 checks), `pylint` (style checks). If the unit tests pass (**try to keep the unit tests coverage high**), the linter checks pass and your pylint score is above the minimum score (that is 9.0), you can make the PR (**try to keep the pylint score as much high as possible!**).
+
+## Commit messages
 
 Commits should start with an emoji and directly followed by a descriptive and precise message that starts with a capital letter and should be written in present tense. E.g:
 
@@ -10,7 +38,7 @@ Commits should start with an emoji and directly followed by a descriptive and pr
 
 Emojis not only look great but also makes you rethink what to add to a commit. The goal is to dedicate each single kind of change to a single commit. Make many but small commits!
 
-Emojis of commit message follow mainly the [Gitmoji](https://gitmoji.dev/) guidline (the different ones start with an asterisk *). The most usefull are:
+Emojis of commit message follow mainly the [Gitmoji](https://gitmoji.dev/) guideline (the different ones start with an asterisk *). The most useful are:
 
 | Emoji                                 | Description                                     |
 | ------------------------------------- | ----------------------------------------------- |

apps/train.py

@@ -86,4 +86,5 @@ def main() -> None:
 if __name__ == '__main__':
     global_config = GlobalConfig.build_from_argv(
         fallback='configs/exp/base.yaml')
+    global_config.save(global_config.config_save_path)
     main()

requirements-dev.txt

@@ -0,0 +1,13 @@
+flake8==4.0.1
+isort==5.10.1
+mypy==0.971
+Pillow==9.2.0
+pydocstyle==6.1.1
+pylint==2.14.5
+pylint-django==2.5.3
+pytest-cov==3.0.0
+--extra-index-url=https://gitlab.com/api/v4/projects/26449469/packages/pypi/simple
+rr_ml_config==1.9.1
+scikit_image==0.19.3
+torch==1.12.0
+wandb==0.12.21

requirements.txt

@@ -1,5 +1,4 @@
 Pillow==9.2.0
-pytest==7.1.2
 --extra-index-url=https://gitlab.com/api/v4/projects/26449469/packages/pypi/simple
 rr_ml_config==1.9.1
 scikit_image==0.19.3