Dogfood markdown files

Signed-off-by: Vadim Markovtsev <vadim@athenian.co>

.github/workflows/push.yml

@@ -90,6 +90,10 @@ jobs:
         diff requirements-lint.txt generated/requirements-lint.txt
         diff requirements-test.txt generated/requirements-test.txt
         diff pyproject.toml generated/pyproject.toml
+        diff DCO.md generated/DCO.md
+        diff CODE_OF_CONDUCT.md generated/CODE_OF_CONDUCT.md
+        diff CONTRIBUTING.md generated/CONTRIBUTING.md
+        diff LICENSE generated/LICENSE
 
     - name: Test with pytest
       run: |
@@ -178,6 +182,10 @@ jobs:
           diff requirements-lint.txt generated/requirements-lint.txt
           diff requirements-test.txt generated/requirements-test.txt
           diff pyproject.toml generated/pyproject.toml
+          diff DCO.md generated/DCO.md
+          diff CODE_OF_CONDUCT.md generated/CODE_OF_CONDUCT.md
+          diff CONTRIBUTING.md generated/CONTRIBUTING.md
+          diff LICENSE generated/LICENSE
 
       - name: Test package
         run: |

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at guillem@fragile.tech.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by 
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available 
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -1,14 +1,14 @@
 # Contributing Guidelines
 
-ML Ops Quickstart is [MIT licensed](LICENSE) and accepts
+mloq is [MIT licensed](LICENSE) and accepts
 contributions via GitHub pull requests.  This document outlines some of the
 conventions on development workflow, commit message formatting, contact points,
 and other resources to make it easier to get your contribution accepted.
 
 ## Certificate of Origin
 
 By contributing to this project you agree to the [Developer Certificate of
-Origin (DCO)](https://github.com/FragileTech/ml-ops-quickstart/blob/master/DCO.md). This document was created by the Linux Kernel community and is a
+Origin (DCO)](DCO.md). This document was created by the Linux Kernel community and is a
 simple statement that you, as a contributor, have the legal right to make the
 contribution.
 
@@ -22,7 +22,7 @@ This can be done easily using the [`-s`](https://github.com/git/git/blob/b2c150d
 
 The official support channels, for both users and contributors, are:
 
-- GitHub [issues](https://github.com/fragiletech/ml-ops-quickstart/issues)*
+- GitHub [issues](https://github.com/FragileTech/ml-ops-quickstart/issues)*
 
 *Before opening a new issue or submitting a new pull request, it's helpful to
 search the project - it's likely that another user has already reported the
@@ -40,7 +40,7 @@ In order for a PR to be accepted it needs to pass a list of requirements:
 - Python code is formatted according to [![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/).
 - If the PR is a bug fix, it has to include a new unit test that fails before the patch is merged.
 - If the PR is a new feature, it has to come with a suite of unit tests, that tests the new functionality.
-- In any case, all the PRs have to pass the personal evaluation of at least one of the maintainers.
+- In any case, all the PRs have to pass the personal evaluation of at least one of the [maintainers](MAINTAINERS.md).
 
 
 ### Format of the commit message

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020, 2021 FragileTech
+Copyright (c) 2021 - 2021 FragileTech
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

docs/source/assets

@@ -0,0 +1 @@
+../../mloq/assets/

mloq.yml

@@ -13,6 +13,7 @@ template:
   owner: FragileTech
   author: FragileTech
   email: guillem@fragile.tech
+  copyright_year: 2020
   copyright_holder: FragileTech
   project_url: https://github.com/FragileTech/ml-ops-quickstart
   bot_name: fragile-bot
@@ -44,4 +45,8 @@ template:
     diff requirements-lint.txt generated/requirements-lint.txt
     diff requirements-test.txt generated/requirements-test.txt
     diff pyproject.toml generated/pyproject.toml
+    diff DCO.md generated/DCO.md
+    diff CODE_OF_CONDUCT.md generated/CODE_OF_CONDUCT.md
+    diff CONTRIBUTING.md generated/CONTRIBUTING.md
+    diff LICENSE generated/LICENSE
   git_message: null

mloq/assets/static/mloq.yml

@@ -21,6 +21,7 @@ template:
   owner:
   author:
   email:
+  copyright_year:
   copyright_holder:
   project_url:
   bot_name:

mloq/assets/templates/CONTRIBUTING.md

@@ -8,7 +8,7 @@ and other resources to make it easier to get your contribution accepted.
 ## Certificate of Origin
 
 By contributing to this project you agree to the [Developer Certificate of
-Origin (DCO)](DCO). This document was created by the Linux Kernel community and is a
+Origin (DCO)](DCO.md). This document was created by the Linux Kernel community and is a
 simple statement that you, as a contributor, have the legal right to make the
 contribution.
 
@@ -22,7 +22,7 @@ This can be done easily using the [`-s`](https://github.com/git/git/blob/b2c150d
 
 The official support channels, for both users and contributors, are:
 
-- GitHub [issues](https://github.com/{{owner}}/{{project_name}}/issues)*
+- GitHub [issues]({{ project_url }}/issues)*
 
 *Before opening a new issue or submitting a new pull request, it's helpful to
 search the project - it's likely that another user has already reported the

mloq/assets/templates/MIT_LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) {{ now().year }} {{copyright_holder}}
+Copyright (c) {{ copyright_year }} - {{ now().year }} {{copyright_holder}}
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

mloq/config/generation.py

@@ -1,4 +1,5 @@
 """Contains the functions that generate the required configuration."""
+from datetime import datetime
 from typing import Optional
 
 from mloq.config.logic import get_docker_image, load_empty_config
@@ -88,6 +89,7 @@ def generate_template(
         interactive,
         default=template["owner"],
     )
+    template["copyright_year"] = datetime.now().year
     template["copyright_holder"] = copyright_holder
     default_url = f"https://github.com/{template['owner']}/{template['project_name']}"
     template["project_url"] = TEMPLATE.project_url(template, interactive, default=default_url)

mloq/config/params.py

@@ -209,6 +209,7 @@ def is_empty(value: Union[str, list, tuple, set]) -> bool:
     ConfigParam("owner", "Github handle of the project owner"),
     ConfigParam("email", "Owner contact email"),
     ConfigParam("author", "Author(s) of the project"),
+    ConfigParam("copyright_year", "Year when the project started"),
     ConfigParam("copyright_holder", "Copyright holder"),
     ConfigParam("project_url", "GitHub project url"),
     ConfigParam("bot_name", "Bot's GitHub login to push commits in CI"),

mloq/tests/conftest.py

@@ -23,6 +23,7 @@ def template():
         "owner": "owner_test",
         "author": "owner_test",
         "email": "owner@mail.com",
+        "copyright_year": 2021,
         "copyright_holder": "owner_test",
         "project_url": "https://github.com/owner_test/test_project",
         "bot_name": "owner_test",

mloq/tests/mloq.yml

@@ -13,6 +13,7 @@ template:
   owner: owner_test
   author: owner_test
   email: owner@mail.com
+  copyright_year: 2021
   copyright_holder: owner_test
   project_url: https://github.com/owner_test/test_project
   download_url: