From d6bbb3253028e3bcf4865b3197a9cce9f59c83b3 Mon Sep 17 00:00:00 2001 From: Adam Pocock Date: Tue, 24 Jan 2023 10:37:52 -0500 Subject: [PATCH] Updating github bits. --- .../workflows/ISSUE_TEMPLATE/bug_report.md | 35 +++++++++++++++++++ .../ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++ .github/workflows/maven-macos.yml | 4 +-- .github/workflows/maven-ubuntu.yml | 4 +-- .github/workflows/maven-windows.yml | 4 +-- .github/workflows/pull_request_template.md | 10 ++++++ 6 files changed, 71 insertions(+), 6 deletions(-) create mode 100644 .github/workflows/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/workflows/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/workflows/pull_request_template.md diff --git a/.github/workflows/ISSUE_TEMPLATE/bug_report.md b/.github/workflows/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..e9b1811d --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Bug reports +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** + +A clear and concise description of what the bug is. + +**To Reproduce** + +Steps to reproduce the behaviour, including a description of how you're using the library preferably with pseudocode or a code snippet. + +**Expected behaviour** + +A clear and concise description of what you expected to happen. + +**Screenshots** + +If applicable, add screenshots to help explain your problem. + +**System information:** + + - OLCUT Version: [e.g., 5.3.0] + - OS: [e.g., Windows/macOS/Linux] + - Java Version: [e.g., 8, 11, 17 etc] + - JDK Vendor: [e.g., Oracle, OpenJDK etc] + +**Additional context** + +Add any other context about the problem here. diff --git a/.github/workflows/ISSUE_TEMPLATE/feature_request.md b/.github/workflows/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..11fc491e --- /dev/null +++ b/.github/workflows/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +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/workflows/maven-macos.yml b/.github/workflows/maven-macos.yml index 407478fc..2d6cd012 100644 --- a/.github/workflows/maven-macos.yml +++ b/.github/workflows/maven-macos.yml @@ -5,9 +5,9 @@ name: OLCUT CI (macOS x86_64, OpenJDK 8, 11, 17) on: push: - branches: [ main, develop ] + branches: [ main ] pull_request: - branches: [ main, develop ] + branches: [ main ] jobs: build: diff --git a/.github/workflows/maven-ubuntu.yml b/.github/workflows/maven-ubuntu.yml index 790f8d06..531a43ae 100644 --- a/.github/workflows/maven-ubuntu.yml +++ b/.github/workflows/maven-ubuntu.yml @@ -5,9 +5,9 @@ name: OLCUT CI (Ubuntu x86_64, OpenJDK 8, 11, 17) on: push: - branches: [ main, develop ] + branches: [ main ] pull_request: - branches: [ main, develop ] + branches: [ main ] jobs: build: diff --git a/.github/workflows/maven-windows.yml b/.github/workflows/maven-windows.yml index 944a0ac8..4dd864eb 100644 --- a/.github/workflows/maven-windows.yml +++ b/.github/workflows/maven-windows.yml @@ -5,9 +5,9 @@ name: OLCUT CI (Windows x86_64, OpenJDK 8, 11, 17) on: push: - branches: [ main, develop ] + branches: [ main ] pull_request: - branches: [ main, develop ] + branches: [ main ] jobs: build: diff --git a/.github/workflows/pull_request_template.md b/.github/workflows/pull_request_template.md new file mode 100644 index 00000000..7883ed03 --- /dev/null +++ b/.github/workflows/pull_request_template.md @@ -0,0 +1,10 @@ +### Description +< Insert text describing your change > + +### Motivation +< Why is this change necessary? Is it a bug fix or new feature? > + +< Please link any relevant issues or PRs > + +### Paper reference +< If this PR introduces a new algorithm or ML feature, please cite the original paper >