diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 171f469cc..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.4 + rev: 5.12.0 hooks: - id: isort args: [ 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 79e876d42..5a8bd31c1 100644 --- a/doc/source/packaging/diag/pyproduct_library_structure_diag.rst +++ b/doc/source/packaging/diag/pyproduct_library_structure_diag.rst @@ -23,10 +23,18 @@ label="doc", shape="folder" ] + source [ + label="source", shape="folder" + ] + src [ label="src", shape="folder" ] + conf_file [ + label="conf.py", shape="file" + ] + ansys [ label="ansys", shape="folder" ] @@ -47,6 +55,10 @@ label="tests", shape="folder" ] + authors [ + label="AUTHORS.md", shape="file" + ] + changelog [ label="CHANGELOG.md", shape="file" ] @@ -79,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; @@ -87,6 +100,9 @@ pyproduct_library -> pyproject; pyproduct_library -> setup; + doc -> source; + source -> conf_file; + src -> ansys; ansys -> product; product -> library; diff --git a/doc/source/packaging/structure.rst b/doc/source/packaging/structure.rst index 8adba0a0a..482097ba2 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/authors_file.md + :language: markdown + + The ``CHANGELOG.md`` file -------------------------