From ad25ad8f2348382dd2035000d215c1cb9f2dd4dd Mon Sep 17 00:00:00 2001 From: Alex Kaszynski Date: Mon, 30 Jan 2023 11:31:43 -0700 Subject: [PATCH 1/4] Update pyproduct_library_structure_diag.rst --- .../diag/pyproduct_library_structure_diag.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/source/packaging/diag/pyproduct_library_structure_diag.rst b/doc/source/packaging/diag/pyproduct_library_structure_diag.rst index 79e876d42..7348ab998 100644 --- a/doc/source/packaging/diag/pyproduct_library_structure_diag.rst +++ b/doc/source/packaging/diag/pyproduct_library_structure_diag.rst @@ -23,6 +23,14 @@ label="doc", shape="folder" ] + source [ + label="source", shape="folder" + ] + + conf.py [ + label="conf.py", shape="file" + ] + src [ label="src", shape="folder" ] @@ -87,6 +95,9 @@ pyproduct_library -> pyproject; pyproduct_library -> setup; + doc -> source; + source -> conf.py; + src -> ansys; ansys -> product; product -> library; From 990064d0758bcd5e2e8dd533db5dc5004591a32c Mon Sep 17 00:00:00 2001 From: Alex Kaszynski Date: Mon, 30 Jan 2023 12:17:42 -0700 Subject: [PATCH 2/4] add authors file --- doc/source/packaging/code/authors_file.md | 11 +++++++++++ .../diag/pyproduct_library_structure_diag.rst | 15 ++++++++++----- doc/source/packaging/structure.rst | 12 ++++++++++++ 3 files changed, 33 insertions(+), 5 deletions(-) create mode 100644 doc/source/packaging/code/authors_file.md diff --git a/doc/source/packaging/code/authors_file.md b/doc/source/packaging/code/authors_file.md new file mode 100644 index 000000000..2aa1cc6ea --- /dev/null +++ b/doc/source/packaging/code/authors_file.md @@ -0,0 +1,11 @@ +# Authors + +## Project Lead or Owner + +* [First Last](https://github.com/ghusername) + +## Contributors + +* [Jane Smith](https://github.com/janesmith) +* [Jim Jones](https://github.com/jimjones) +* [Jack Johnson](https://github.com/jackjohnson) diff --git a/doc/source/packaging/diag/pyproduct_library_structure_diag.rst b/doc/source/packaging/diag/pyproduct_library_structure_diag.rst index 7348ab998..5a8bd31c1 100644 --- a/doc/source/packaging/diag/pyproduct_library_structure_diag.rst +++ b/doc/source/packaging/diag/pyproduct_library_structure_diag.rst @@ -27,14 +27,14 @@ label="source", shape="folder" ] - conf.py [ - label="conf.py", shape="file" - ] - src [ label="src", shape="folder" ] + conf_file [ + label="conf.py", shape="file" + ] + ansys [ label="ansys", shape="folder" ] @@ -55,6 +55,10 @@ label="tests", shape="folder" ] + authors [ + label="AUTHORS.md", shape="file" + ] + changelog [ label="CHANGELOG.md", shape="file" ] @@ -87,6 +91,7 @@ pyproduct_library -> doc; pyproduct_library -> src; pyproduct_library -> tests; + pyproduct_library -> authors; pyproduct_library -> license; pyproduct_library -> changelog; pyproduct_library -> code_of_conduct; @@ -96,7 +101,7 @@ pyproduct_library -> setup; doc -> source; - source -> conf.py; + source -> conf_file; src -> ansys; ansys -> product; diff --git a/doc/source/packaging/structure.rst b/doc/source/packaging/structure.rst index 8adba0a0a..5f32ca275 100644 --- a/doc/source/packaging/structure.rst +++ b/doc/source/packaging/structure.rst @@ -201,6 +201,18 @@ This is the preferred way of naming directories and files inside the ``tests/`` directory. + +The ``AUTHORS.md`` file +----------------------- +An ``AUTHORS.md`` file is used to list the authors of the repository. It is +used to credit the authors for their individual contributions and provide a +record of authorship for the codebase. Use your first and last name and provide +a link to your GitHub username. + +.. literalinclude:: code/changelog_file.md + :language: markdown + + The ``CHANGELOG.md`` file ------------------------- From 83257becaec41d662a58802fd27441172356fe8d Mon Sep 17 00:00:00 2001 From: Alex Kaszynski Date: Mon, 30 Jan 2023 12:23:45 -0700 Subject: [PATCH 3/4] bump 5.11.5 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 171f469cc..1cd4ca322 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -14,7 +14,7 @@ repos: additional_dependencies: [black==22.12.0] - repo: https://github.com/pycqa/isort - rev: 5.11.4 + rev: 5.11.5 hooks: - id: isort args: [ From 0cd8f2e8c02973386fbef18a6edf127ff1131516 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jorge=20Mart=C3=ADnez?= <28702884+jorgepiloto@users.noreply.github.com> Date: Tue, 31 Jan 2023 06:54:10 +0100 Subject: [PATCH 4/4] FIX: links and names --- .pre-commit-config.yaml | 2 +- doc/source/packaging/structure.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1cd4ca322..59050bb20 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -14,7 +14,7 @@ repos: additional_dependencies: [black==22.12.0] - repo: https://github.com/pycqa/isort - rev: 5.11.5 + rev: 5.12.0 hooks: - id: isort args: [ diff --git a/doc/source/packaging/structure.rst b/doc/source/packaging/structure.rst index 5f32ca275..482097ba2 100644 --- a/doc/source/packaging/structure.rst +++ b/doc/source/packaging/structure.rst @@ -209,7 +209,7 @@ used to credit the authors for their individual contributions and provide a record of authorship for the codebase. Use your first and last name and provide a link to your GitHub username. -.. literalinclude:: code/changelog_file.md +.. literalinclude:: code/authors_file.md :language: markdown