Create pyDOMCFG skeleton

[malmans2]

No description provided.

[codecov]

Codecov Report

❗ No coverage uploaded for pull request base (main@9148607). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main       #1   +/-   ##
=======================================
  Coverage        ?   60.00%           
=======================================
  Files           ?        1           
  Lines           ?        5           
  Branches        ?        0           
=======================================
  Hits            ?        3           
  Misses          ?        2           
  Partials        ?        0           

Flag	Coverage Δ
unittests	60.00% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9148607...5530936. Read the comment docs.

[malmans2]

@pyNEMO/pydomcfg I think we're all set (the only workflow missing is the one that pushes to PyPI and conda-forge when we tag and release on GitHub. I'll do it when we're ready for the first release).

Workflows (click on the checks at the bottom of this PR for more info):

• Test python 3.7-9 and using dev version of core dependencies for each PR and once a week
• Estimate percentage of code tested
• Build the documentation for each PR (click on Details near the rtd check to get the URL)
• Run pre-commit (lint using isort and black, check PEP8 compliance with flake8, check docstrings using darglint, run mypy for static type checks)

I've set it so that by default all checks must pass + one approving review is needed to merge to main. But we all should have admin permissions, so we should be able to merge anyways.

I'll document how to use pre-commit/tests/sphinx tomorrow!

[malmans2]

OK, I added everything I thought could be helpful to get started. See docs for developers.
I kept it very brief, it should be good to get started, then you can follow the links for more advance stuff...
Documentation built for this PR is hosted here: https://pydomcfg--1.org.readthedocs.build/en/1/developers/contributing.html

[malmans2]

Merging so @oceandie can work on #2