From b40322bcb28a9e41e1ac4ecab445f62acb49f7cd Mon Sep 17 00:00:00 2001 From: webb-ben Date: Thu, 4 Apr 2024 22:06:22 -0400 Subject: [PATCH] Add cgs-earth/template repository configuration --- .github/ISSUE_TEMPLATE/bug_report.md | 29 +++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation_issue.md | 23 +++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 21 ++++++++++++++ .github/pull_request_template.md | 11 +++++++ .github/workflows/flake8.yml | 24 +++++++++++++++ 5 files changed, 108 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/documentation_issue.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/flake8.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..3671b97 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,29 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + + +**Description** +A clear and concise description of what the bug is. + +**Steps to Reproduce** +Steps to reproduce the behavior: + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots/Tracebacks** +If applicable, add screenshots to help explain your problem. + +**Environment** + - OS: + - Python version: + - Python env/venv: + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/documentation_issue.md b/.github/ISSUE_TEMPLATE/documentation_issue.md new file mode 100644 index 0000000..109cbf0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_issue.md @@ -0,0 +1,23 @@ +--- +name: Documentation issue +about: Create a report to improve documenation +title: '' +labels: documentation +assignees: '' + +--- + +**Description** +A clear and concise description of the documentation issue or improvement + +**Current Documentation** +Links or description of the current documentation. + +**Suggested Improvement** +Describe the suggested improvement or fix. + +**Steps to Reproduce (if applicable)** +If relevant, steps to reproduce the issue with the current documentation. + +**Additional Context** +Any additional context, screenshots, or code examples. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..229493e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,21 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..99272cc --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,11 @@ +# Description + + +# Changes Made + + +# Related Issues + + +# Additional Notes + diff --git a/.github/workflows/flake8.yml b/.github/workflows/flake8.yml new file mode 100644 index 0000000..c7f3d3d --- /dev/null +++ b/.github/workflows/flake8.yml @@ -0,0 +1,24 @@ +name: flake8 ⚙️ + +on: [ push, pull_request ] + +jobs: + main: + runs-on: ubuntu-latest + + steps: + - name: Setup Python + uses: actions/setup-python@v1 + with: + python-version: 3.8 + architecture: x64 + - name: Checkout repository + uses: actions/checkout@master + - name: Install flake8 + run: pip install flake8 flake8-nb + - name: run flake8 ⚙️ + run: | + find . -type f -name "*.py" | xargs flake8 + - name: run flake8-notebook ⚙️ + run: | + find . -type f -name "*.ipynb" | xargs flake8-nb