.auto-changelog

@@ -3,7 +3,7 @@
     "template": ".auto-changelog-template.hbs",
     "commitLimit": false,
     "backfillLimit": false,
-    "ignoreCommitPattern": "Release:? [0-9]+\\.[0-9]+\\.[0-9]+|Update CHANGELOG.*|.*\\[skip-changelog\\].*|\\[pre-commit.ci\\]",
+    "ignoreCommitPattern": "^Release:? [0-9]+\\.[0-9]+\\.[0-9]+( ?\\(#[0-9]+\\))?$|^Update CHANGELOG.*|.*\\[skip-changelog\\].*|^\\[pre-commit.ci\\]|^\\(dependabot\\) .*",
     "commitUrl": "https://github.com/BlueBrain/dir-content-diff/commit/{id}",
     "issueUrl": "https://github.com/BlueBrain/dir-content-diff/issues/{id}",
     "mergeUrl": "https://github.com/BlueBrain/dir-content-diff/pull/{id}",

.auto-changelog-template.hbs

@@ -136,7 +136,7 @@ Example Definitions
         - {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
       {{/commit-list}}
 
-      {{#commit-list merges heading='### General Changes' exclude='[bB]reaking [cC]hange:|[bB]reaking:|^[bB]uild:|^[bB]uild\(|^[dD]eprecate:|^[dD]eprecate\(|^[fF]eat:|^[fF]eat\(|^[fF]ix:|^[fF]ix\(|^[cC]hore:|^[cC]hore\(|^[cC][iI]:|^[cC][iI]\(|^[dD]ocs:|^[dD]ocs\(|^[rR]efactor:|^[rR]efactor\(|^[tT]est:|^[tT]est\(|^[sS]tyle:|^[sS]tyle\(|^[pP]erf:|^[pP]erf\(|\[skip-changelog\]'}}
+      {{#commit-list merges heading='### General Changes' exclude='[bB]reaking [cC]hange:|[bB]reaking:|^[bB]uild:|^[bB]uild ?\(|^[dD]eprecate:|^[dD]eprecate ?\(|^[fF]eat:|^[fF]eat ?\(|^[fF]ix:|^[fF]ix ?\(|^[cC]hore:|^[cC]hore ?\(|^[cC][iI]:|^[cC][iI] ?\(|^[dD]ocs:|^[dD]ocs ?\(|^[rR]efactor:|^[rR]efactor ?\(|^[tT]est:|^[tT]est ?\(|^[sS]tyle:|^[sS]tyle ?\(|^[pP]erf:|^[pP]erf ?\(|\[skip-changelog\]'}}
         - {{message}} ({{author}}{{#if href}} - [#{{id}}]({{href}}){{/if}})
       {{/commit-list}}
 
@@ -190,7 +190,7 @@ Example Definitions
         - {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
       {{/commit-list}}
 
-      {{#commit-list commits heading='### General Changes' exclude='[bB]reaking [cC]hange:|[bB]reaking:|^[bB]uild:|^[bB]uild\(|^[dD]eprecate:|^[dD]eprecate\(|^[fF]eat:|^[fF]eat\(|^[fF]ix:|^[fF]ix\(|^[cC]hore:|^[cC]hore\(|^[cC][iI]:|^[cC][iI]\(|^[dD]ocs:|^[dD]ocs\(|^[rR]efactor:|^[rR]efactor\(|^[tT]est:|^[tT]est\(|^[sS]tyle:|^[sS]tyle\(|^[pP]erf:|^[pP]erf\(|\[skip-changelog\]'}}
+      {{#commit-list commits heading='### General Changes' exclude='[bB]reaking [cC]hange:|[bB]reaking:|^[bB]uild:|^[bB]uild ?\(|^[dD]eprecate:|^[dD]eprecate ?\(|^[fF]eat:|^[fF]eat ?\(|^[fF]ix:|^[fF]ix ?\(|^[cC]hore:|^[cC]hore ?\(|^[cC][iI]:|^[cC][iI] ?\(|^[dD]ocs:|^[dD]ocs ?\(|^[rR]efactor:|^[rR]efactor ?\(|^[tT]est:|^[tT]est ?\(|^[sS]tyle:|^[sS]tyle ?\(|^[pP]erf:|^[pP]erf ?\(|\[skip-changelog\]'}}
         - {{subject}} ({{author}}{{#if href}} - [{{shorthash}}]({{href}}){{/if}})
       {{/commit-list}}
 

.codespellrc

@@ -1,2 +1,2 @@
 [codespell]
-skip = .git/*
+skip = .git/*,*.pdf

.copier-answers.yml

@@ -1,11 +1,11 @@
 # Changes here will be overwritten by Copier
 
-_commit: 0.1.40
+_commit: 0.1.67
 _src_path: git@bbpgitlab.epfl.ch:neuromath/python-template.git
 author_email: ''
 author_name: Blue Brain Project, EPFL
 copyright_license: Apache License 2.0
-copyright_year: '2022'
+copyright_year: '2023'
 distribution_name: dir-content-diff
 download_url: https://github.com/BlueBrain/dir-content-diff
 init_git: false
@@ -17,11 +17,11 @@ project_url: https://dir-content-diff.readthedocs.io
 repository_name: dir-content-diff
 repository_namespace: BlueBrain
 repository_provider: github
+setup_codeql: false
 ssh_url: git@github.com:BlueBrain/dir-content-diff.git
-support_py37: false
 team_name: ''
 tracker_url: https://github.com/BlueBrain/dir-content-diff/issues
-use_pyproject_toml: false
+use_pyproject_toml: true
 version: 1.1.0
 
 # End of Copier answers

.copyright.tmpl

@@ -0,0 +1,6 @@
+Copyright (c) 2023-${edit_year} Blue Brain Project, EPFL.
+
+This file is part of dir-content-diff.
+See https://github.com/BlueBrain/dir-content-diff for further info.
+
+SPDX-License-Identifier: Apache-2.0

.coveragerc_min_versions

@@ -0,0 +1,11 @@
+[paths]
+source_paths =
+	dir_content_diff
+	*/site-packages/dir_content_diff
+	*/dir_content_diff/dir_content_diff
+	*/dir-content-diff/dir_content_diff
+
+[report]
+exclude_also =
+    return pd\.read_feather\(path, \*\*kwargs\)
+    data\.to_feather\(path, \*\*kwargs\)

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,114 @@
+# docs https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
+
+name: Create a bug report regarding Directory Content Difference runtime behavior
+description: Errors and regression reports with complete reproducing test cases and/or stack traces.
+labels: [bug]
+title: "[Bug report] "
+body:
+  - type: markdown
+    attributes:
+      value: "
+Thanks for taking the time to fill out this bug report!
+
+
+Before submitting, make sure you search in the [issue list](https://github.com/BlueBrain/dir-content-diff/issues) that a similar issue was not already reported.
+If it is not the case, please read the following guidelines.
+
+### GUIDELINES FOR REPORTING BUGS
+
+Bug reports that are not properly formulated and formatted or without enough details can be very hard for us to understand and fix.
+In order to ensure we can help you fixing your bug, please follow these guidelines.
+
+
+Your reports must include the following features:
+
+1. **succinct description** of the problem - typically a line or two at most.
+
+2. **succinct, dependency-free code** which reproduces the problem, otherwise known as a [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) example.
+  IF YOU DO NOT HAVE A COMPLETE, RUNNABLE TEST CASE WRITTEN DIRECTLY IN THE TEXTAREA BELOW, YOUR ISSUE MAY BE CLOSED.
+
+3. **complete stack traces for all errors** - please avoid screenshots, use formatted text inside issues.
+
+4. other relevant things as applicable: **dependencies**, **comparative performance timings** for performance issues, etc.
+"
+
+  - type: textarea
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: input
+    id: relevant_documentation
+    attributes:
+      label: Optional link from https://dir-content-diff.readthedocs.io which documents the behavior that is expected
+      description: "
+Please make sure the behavior you are seeing is definitely in contradiction to what's documented as the correct behavior.
+"
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: To Reproduce
+      description: "
+Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) example here."
+      placeholder: "# Insert code here (text area already python formatted)"
+      render: Python
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Error
+      description: "
+Provide the complete text of any errors received **including the complete stack trace**.
+If the message is a warning, run your program with the ``-Werror`` flag: ``python -Werror myprogram.py``
+"
+      placeholder: "# Copy the complete stack trace and error message here (text area already formatted for Python backtrace)"
+      render: Python traceback
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.
+    validations:
+      required: false
+
+  - type: input
+    id: package_version
+    attributes:
+      label: dir_content_diff Version in Use
+      description: e.g. 1.4.42, 2.0.2, etc or commit hash
+    validations:
+      required: true
+
+  - type: input
+    id: python_version
+    attributes:
+      label: Python Version
+      description: Assumes cpython unless otherwise stated, e.g. 3.10, 3.11, pypy
+    validations:
+      required: true
+
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating system
+      description: Check all that apply
+      multiple: true
+      options:
+        - Linux
+        - MacOS
+        - Windows
+        - Other
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: "### Thanks! Have a nice day!"

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -0,0 +1,56 @@
+# docs https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
+
+name: Request a new use case
+description: Support for new features
+labels: [enhancement]
+title: "[Feature request] "
+body:
+  - type: markdown
+    attributes:
+      value: "
+Thanks for taking the time to fill out this feature request!
+
+
+Before submitting, make sure the feature does not already exist in the [documentation](https://dir-content-diff.readthedocs.io) and that you searched in the [issue list](https://github.com/BlueBrain/dir-content-diff/issues) that a similar feature request has not already been reported.
+If it is not the case, please read the following guidelines.
+
+### GUIDELINES FOR REQUESTING HELP
+
+Feature requests that are not properly formulated and formatted or without enough details can be very hard for us to understand.
+In order to ensure we can help you, please follow these guidelines.
+
+
+Your requests must include the following features:
+
+1. **succinct description** of the feature - typically a line or two at most to describe what the new feature would do.
+
+2. **succinct, dependency-free code** which shows how you would like to use this feature, otherwise known as a [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) example.
+
+3. Why do you need this feature? What would be the use cases?
+"
+
+  - type: textarea
+    attributes:
+      label: Describe the feature
+      description: A clear and concise description of what the feature would consist in.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Example Use
+      description: Provide a clear example of what the usage of this feature would look like.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Use cases
+      description: Add as much information as possible about the use cases here.
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: "### Thanks! Have a nice day!"

.github/ISSUE_TEMPLATE/how_to_use.yaml

@@ -0,0 +1,91 @@
+# docs https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
+
+name: Ask for help about Directory Content Difference
+description: Questions about dir_content_diff features.
+labels: [how to use]
+title: "[How to use] "
+body:
+  - type: markdown
+    attributes:
+      value: "
+Thanks for using this package and taking the time to fill out this help request!
+
+
+Before submitting, make sure you read the [documentation](https://dir-content-diff.readthedocs.io) carefully.
+If you still have a question, you should search in the [issue list](https://github.com/BlueBrain/dir-content-diff/issues) that a similar issue has not already been reported, you might find your answer there.
+If it is not the case, please read the following guidelines.
+
+### GUIDELINES FOR REQUESTING HELP
+
+Questions that are not properly formulated and formatted or without enough details can be very hard for us to understand.
+In order to ensure we can help you, please follow these guidelines.
+
+
+Your requests must include the following features:
+
+1. **succinct description** of the problem - typically a line or two at most to describe what you want to achieve.
+
+2. **succinct, dependency-free code** which shows what you tried to do, otherwise known as a [Minimal, Complete, and Verifiable Example](https://stackoverflow.com/help/mcve).
+
+3. **expected results**
+
+4. **complete stack traces for all errors** if you have any - please avoid screenshots, use formatted text inside issues.
+
+5. other relevant things: **dependencies**, **operating system**, **comparative performance timings** for performance issues.
+"
+
+  - type: textarea
+    attributes:
+      label: Describe the problem
+      description: A clear and concise description of what you want to achieve.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Show what you tried to do.
+      description: "
+Provide your [Minimal, Complete, and Verifiable Example](https://stackoverflow.com/help/mcve) here."
+      placeholder: "# Insert code here (text area already python formatted)"
+      render: Python
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Describe what you expected.
+      description: A clear and concise description of what you which result you expected by doing this.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Error
+      description: "
+If you are facing an arror, provide the complete text of any errors received **including the complete stack trace**.
+If the message is a warning, run your program with the ``-Werror`` flag: ``python -Werror myprogram.py``
+"
+      placeholder: "# Copy the complete stack trace and error message here (text area already formatted for Python backtrace)"
+      render: Python traceback
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.
+    validations:
+      required: false
+
+  - type: input
+    id: package_version
+    attributes:
+      label: dir_content_diff Version in Use
+      description: e.g. 1.4.42, 2.0.2, etc or commit hash
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: "### Thanks! Have a nice day!"

.github/dependabot.yml

@@ -11,3 +11,6 @@ updates:
     directory: "/" # Check the repository's workflows under /.github/workflows/
     schedule:
       interval: "weekly"
+    commit-message:
+      # Prefix all commit messages with "CI(dependabot): "
+      prefix: "CI(dependabot): "

.github/pull_request_template.md

@@ -0,0 +1,24 @@
+<!-- Provide a general summary of your proposed changes in the Title field above -->
+<!-- The title should have the following form: 'Type: Subject' with 'type' in [Build,Chore,CI,Reprecate,Docs,Feat,Fix,Perf,Refactor,Revert,Style,Test] -->
+
+### Description
+<!-- Describe your changes in detail and the reasons of these changes -->
+
+### Checklist
+<!-- Go over following points. Check them with an `x` if they do apply (they turn into clickable checkboxes once the PR is submitted, so no need to do everything at once). -->
+
+This pull request is:
+
+- [ ] A documentation / typographical error fix
+	- Good to go, no issue or tests are needed
+- [ ] A short code fix
+	- [ ] Please include: `Fixes: #<issue number>` in the description if it solves an existing issue
+	  (which must include a complete example of the issue).
+	- [ ] Please include tests that fail with the `main` branch and pass with the provided fix.
+- [ ] A new feature implementation or update an existing feature
+	- [ ] Please include: `Fixes: #<issue number>` in the description if it solves an existing issue
+	  (which must include a complete example of the feature).
+	- [ ] Please include tests that cover every lines of the new/updated feature.
+	- [ ] Please update the documentation to describe the new/updated feature.
+
+<!-- **Have a nice day!** -->