This commit is contained in:
47
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
47
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,47 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: The openTCS Authors
|
||||
SPDX-License-Identifier: CC-BY-4.0
|
||||
-->
|
||||
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Affected version
|
||||
|
||||
_Name the affected version, i.e. "release x.y.z" or "revision <HASH>"._
|
||||
|
||||
...
|
||||
|
||||
## Steps to reproduce
|
||||
|
||||
_How can the incorrect behaviour be reproduced?_
|
||||
|
||||
1. ...
|
||||
2. ...
|
||||
3. ...
|
||||
|
||||
### Expected behaviour
|
||||
|
||||
_What would be the correct/expected behaviour?_
|
||||
|
||||
...
|
||||
|
||||
### Actual behaviour
|
||||
|
||||
_What behaviour can actually be observed instead of the correct behaviour?_
|
||||
|
||||
...
|
||||
|
||||
### Additional information
|
||||
|
||||
_Other data that can help with fixing the defect, e.g. logs, screenshots etc._
|
||||
|
||||
* Operating system and version: _e.g. Ubuntu Linux 20.04, Windows 10, ..._
|
||||
* Java distribution version: _e.g. Oracle Java Runtime Environment 13_
|
||||
* ...
|
||||
9
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
9
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,9 @@
|
||||
# SPDX-FileCopyrightText: The openTCS Authors
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
---
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Ask a question or get support
|
||||
url: https://github.com/opentcs/opentcs/discussions
|
||||
about: Ask a question or request support for using openTCS
|
||||
17
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
17
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: The openTCS Authors
|
||||
SPDX-License-Identifier: CC-BY-4.0
|
||||
-->
|
||||
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## User story / use case
|
||||
|
||||
_A description of the proposed functionality. What is the purpose of this proposal? What problems would it solve? Are there already ideas for a solution?_
|
||||
51
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
51
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,51 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: The openTCS Authors
|
||||
SPDX-License-Identifier: CC-BY-4.0
|
||||
-->
|
||||
|
||||
## Description
|
||||
|
||||
<!--
|
||||
Please explain the changes you made here, and why you made them.
|
||||
If this PR is related to an issue, reference it here.
|
||||
Note that, with a reference to an issue and/or an expressive commit message (see below), you can usually keep this quite short.
|
||||
-->
|
||||
|
||||
...
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] You have the right to contribute the code/documentation/assets to this project, and you agree to contribute it under the terms of the project's license(s).
|
||||
- [ ] All changes have been made on a separate branch (not master) in a fork.
|
||||
- [ ] The whole project compiles correctly and all tests pass, i.e. `gradlew clean build` succeeds with the changes made, and without unavoidable compiler/toolchain warnings.
|
||||
- [ ] New tests covering the change have been added, if it is possible / makes sense.
|
||||
- [ ] The documentation has been extended, if necessary.
|
||||
- [ ] The PR contains a proposal for a _well-formed_ commit message that mentions all authors who contributed to the PR.
|
||||
(The commits in the PR will be squashed into one commit on the base branch, and your proposed message is intended to be used for this commit. See below for a template you can use for the message. See [this blog post](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) and [this one](https://chris.beams.io/posts/git-commit/#seven-rules) for more on well-formed commit messages.)
|
||||
|
||||
## Proposed squash commit message
|
||||
|
||||
<!--
|
||||
A proposed message for the eventual squashed commit.
|
||||
Please stick to the following pattern:
|
||||
|
||||
- A short one-line summary (max. 50 characters).
|
||||
- A blank line.
|
||||
- A detailed explanation of the changes introduced by this merge request.
|
||||
Each line should not exceed 72 characters.
|
||||
*********1*********2*********3*********4*********5*********6*********7** (<-- Ruler for line width assistance)
|
||||
-->
|
||||
```
|
||||
A short one-line summary (max. 50 characters)
|
||||
|
||||
A more detailed explanation of the changes introduced by this merge
|
||||
request.
|
||||
|
||||
* You can use lists here, too.
|
||||
* Each line should not exceed 72 characters.
|
||||
|
||||
Co-authored-by: NAME <EMAIL>
|
||||
```
|
||||
<!--
|
||||
*********1*********2*********3*********4*********5*********6*********7** (<-- Ruler for line width assistance)
|
||||
-->
|
||||
43
.github/workflows/build.yml
vendored
Normal file
43
.github/workflows/build.yml
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
# SPDX-FileCopyrightText: The openTCS Authors
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
name: Gradle Build
|
||||
|
||||
on: [push, pull_request]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-22.04
|
||||
|
||||
steps:
|
||||
- name: Check out repository
|
||||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # (=v4.1.1)
|
||||
- name: Set up JDK 21
|
||||
uses: actions/setup-java@387ac29b308b003ca37ba93a6cab5eb57c8f5f93 # (=v4.0.0)
|
||||
with:
|
||||
java-version: '21'
|
||||
distribution: 'temurin'
|
||||
- name: Validate Gradle wrapper
|
||||
uses: gradle/wrapper-validation-action@699bb18358f12c5b78b37bb0111d3a0e2276e0e2 # (=v2.1.1)
|
||||
- name: Cache Gradle packages
|
||||
uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2 # (=v4.0.0)
|
||||
with:
|
||||
path: |
|
||||
~/.gradle/caches
|
||||
~/.gradle/wrapper
|
||||
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-gradle-
|
||||
- name: Build with Gradle
|
||||
run: ./gradlew build
|
||||
- name: Check code formatting
|
||||
run: ./gradlew spotlessCheck
|
||||
- name: Cleanup Gradle Cache
|
||||
# Remove some files from the Gradle cache, so they aren't cached by GitHub Actions.
|
||||
# Restoring these files from a GitHub Actions cache might cause problems for future builds.
|
||||
run: |
|
||||
rm -f ~/.gradle/caches/modules-2/modules-2.lock
|
||||
rm -f ~/.gradle/caches/modules-2/gc.properties
|
||||
Reference in New Issue
Block a user