From a29e76ff91c93ebe0034d9dd3c814be2eb6e591a Mon Sep 17 00:00:00 2001 From: Drew Oldag Date: Mon, 28 Oct 2024 11:13:17 -0700 Subject: [PATCH] Splitting the README into two smaller READMEs and putting them in subdirectories so they are not displayed as the default for the whole repo. --- .../.github/ISSUE_TEMPLATE/README.md | 9 ++++++++ python-project-template/.github/README.md | 23 ------------------- .../.github/workflows/README.md | 9 ++++++++ 3 files changed, 18 insertions(+), 23 deletions(-) create mode 100644 python-project-template/.github/ISSUE_TEMPLATE/README.md delete mode 100644 python-project-template/.github/README.md create mode 100644 python-project-template/.github/workflows/README.md diff --git a/python-project-template/.github/ISSUE_TEMPLATE/README.md b/python-project-template/.github/ISSUE_TEMPLATE/README.md new file mode 100644 index 0000000..46dc08e --- /dev/null +++ b/python-project-template/.github/ISSUE_TEMPLATE/README.md @@ -0,0 +1,9 @@ +# Configurations + +Templates for various different issue types are defined in this directory +and a pull request template is defined as ``../pull_request_template.md``. Adding, +removing, and modifying these templates to suit the needs of your project is encouraged. + +For more information about these templates, look here: https://lincc-ppt.readthedocs.io/en/latest/practices/issue_pr_templating.html + +Or if you still have questions contact us: https://lincc-ppt.readthedocs.io/en/latest/source/contact.html \ No newline at end of file diff --git a/python-project-template/.github/README.md b/python-project-template/.github/README.md deleted file mode 100644 index 5fe2a01..0000000 --- a/python-project-template/.github/README.md +++ /dev/null @@ -1,23 +0,0 @@ -# The .github directory - -This directory contains various configurations and .yml files that are used to -define GitHub actions and behaviors. - -## Workflows - -The .yml files in ``./workflows`` are used to define the various continuous -integration scripts that will be run on your behalf e.g. nightly as a smoke check, -or when you create a new PR. - -For more information about CI and workflows, look here: https://lincc-ppt.readthedocs.io/en/latest/practices/ci.html - -## Configurations - -Templates for various different issue types are defined in ``./ISSUE_TEMPLATE`` -and a pull request template is defined as ``pull_request_template.md``. Adding, -removing, and modifying these templates to suit the needs of your project is encouraged. - -For more information about these templates, look here: https://lincc-ppt.readthedocs.io/en/latest/practices/issue_pr_templating.html - - -Or if you still have questions contact us: https://lincc-ppt.readthedocs.io/en/latest/source/contact.html \ No newline at end of file diff --git a/python-project-template/.github/workflows/README.md b/python-project-template/.github/workflows/README.md new file mode 100644 index 0000000..e34a71f --- /dev/null +++ b/python-project-template/.github/workflows/README.md @@ -0,0 +1,9 @@ +# Workflows + +The .yml files in this directory are used to define the various continuous +integration scripts that will be run on your behalf e.g. nightly as a smoke check, +or when you create a new PR. + +For more information about CI and workflows, look here: https://lincc-ppt.readthedocs.io/en/latest/practices/ci.html + +Or if you still have questions contact us: https://lincc-ppt.readthedocs.io/en/latest/source/contact.html \ No newline at end of file