[Doc] Repository documentation (#117)
This commit is contained in:
1 parent
47839cfd05
commit
cca6c47d4a
7 files changed
+277
-11
No files matched your search
@@ -0,0 +1,31 @@
|
||||
name: Bug Report
|
||||
description: Create a report to help reproduce and fix the issue
|
||||
title: "Bug: "
|
||||
labels: [ bug ]
|
||||
body:
|
||||
- type: input
|
||||
attributes:
|
||||
label: Version
|
||||
description: What version of imgui-java did you use?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: Also tell us, what did you expect to happen?
|
||||
placeholder: Tell us what you see!
|
||||
value: A bug happened!
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Reproduction
|
||||
description: How did you manage to make the error happen?
|
||||
placeholder: How did you do it?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Relevant log output
|
||||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
|
||||
render: bash
|
||||
@@ -0,0 +1,38 @@
|
||||
name: Missing Bindings
|
||||
description: Create a report to help reproduce and fix the issue
|
||||
title: "Missing Bindings: "
|
||||
labels: [ "missing binding" ]
|
||||
body:
|
||||
- type: input
|
||||
attributes:
|
||||
label: Version
|
||||
description: What version of imgui-java did you use?
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
attributes:
|
||||
label: What part of the binding has gaps?
|
||||
options:
|
||||
- Dear ImGui
|
||||
- ImNodes
|
||||
- imgui-node-editor
|
||||
- ImGuizmo
|
||||
- implot
|
||||
- ImGuiColorTextEdit
|
||||
- ImGuiFileDialog
|
||||
- ImGui Club MemoryEditor
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: What is missing?
|
||||
description: Tell us, what part of the API is missing?
|
||||
placeholder: Tell us what you are missing!
|
||||
value: Something is missing!
|
||||
validations:
|
||||
required: true
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Please, provide additional references like links to a source code of the missing API.
|
||||
If there are several ways to implement the API, provide a pov of yourself.
|
||||
@@ -0,0 +1,26 @@
|
||||
# Description
|
||||
|
||||
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
|
||||
|
||||
Fixes # (issue)
|
||||
|
||||
## Type of change
|
||||
|
||||
Please check options that are relevant.
|
||||
|
||||
- [ ] Minor changes or tweaks (quality of life stuff)
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||
- [ ] This change requires a documentation update
|
||||
|
||||
# Checklist:
|
||||
|
||||
- [ ] My code follows the style guidelines of this project
|
||||
- [ ] I have performed a self-review of my own code
|
||||
- [ ] I have commented my code, particularly in hard-to-understand areas
|
||||
- [ ] I have made corresponding changes to the documentation
|
||||
- [ ] My changes generate no new warnings
|
||||
- [ ] I have added tests that prove my fix is effective or that my feature works
|
||||
- [ ] New and existing unit tests pass locally with my changes
|
||||
- [ ] Any dependent changes have been merged and published in downstream modules
|
||||
+10
-10
@@ -1,10 +1,10 @@
|
||||
name: CI
|
||||
on: [push, pull_request]
|
||||
on: [push]
|
||||
jobs:
|
||||
build-java:
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-20.04, macos-10.15]
|
||||
os: [ubuntu-latest, macos-latest]
|
||||
name: Build Java
|
||||
runs-on: ${{ matrix.os }}
|
||||
steps:
|
||||
@@ -25,7 +25,7 @@ jobs:
|
||||
FREETYPE_URL: https://download.savannah.gnu.org/releases/freetype/freetype-2.10.4.tar.gz
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-20.04, macos-10.15]
|
||||
os: [ubuntu-latest, macos-latest]
|
||||
type: [win, linux, mac]
|
||||
freetype: [true, false]
|
||||
include:
|
||||
@@ -36,11 +36,11 @@ jobs:
|
||||
- type: mac
|
||||
expected: /tmp/imgui/libsNative/macosx64/libimgui-java64.dylib
|
||||
exclude:
|
||||
- os: ubuntu-20.04
|
||||
- os: ubuntu-latest
|
||||
type: mac
|
||||
- os: macos-10.15
|
||||
- os: macos-latest
|
||||
type: win
|
||||
- os: macos-10.15
|
||||
- os: macos-latest
|
||||
type: linux
|
||||
name: Build Native (type=${{ matrix.type }}, freetype=${{ matrix.freetype }})
|
||||
runs-on: ${{ matrix.os }}
|
||||
@@ -58,22 +58,22 @@ jobs:
|
||||
- name: Ant Version
|
||||
run: ant -version
|
||||
|
||||
- if: matrix.os == 'ubuntu-20.04'
|
||||
- if: matrix.os == 'ubuntu-latest'
|
||||
name: Install MinGW-w64/GCC/G++
|
||||
run: sudo apt install mingw-w64
|
||||
|
||||
- if: matrix.os == 'ubuntu-20.04' && matrix.type == 'linux' && matrix.freetype == true
|
||||
- if: matrix.os == 'ubuntu-latest' && matrix.type == 'linux' && matrix.freetype == true
|
||||
name: FreeType - Install
|
||||
run: sudo apt install libfreetype6-dev
|
||||
|
||||
- if: matrix.os == 'ubuntu-20.04' && matrix.type == 'win' && matrix.freetype == true
|
||||
- if: matrix.os == 'ubuntu-latest' && matrix.type == 'win' && matrix.freetype == true
|
||||
name: FreeType - Download
|
||||
run: |
|
||||
sudo wget -O /freetype.tar.gz ${{ env.FREETYPE_URL }}
|
||||
sudo mkdir /freetype
|
||||
sudo tar -xzf /freetype.tar.gz -C /freetype --strip-components=1
|
||||
|
||||
- if: matrix.os == 'ubuntu-20.04' && matrix.type == 'win' && matrix.freetype == true
|
||||
- if: matrix.os == 'ubuntu-latest' && matrix.type == 'win' && matrix.freetype == true
|
||||
name: FreeType - Compile & Install
|
||||
working-directory: /freetype
|
||||
run: |
|
||||
|
||||
@@ -9,7 +9,7 @@ jobs:
|
||||
uses: dawidd6/action-download-artifact@v2
|
||||
with:
|
||||
workflow: ci.yml
|
||||
branch: master
|
||||
branch: main
|
||||
event: push
|
||||
path: /tmp/artifacts
|
||||
|
||||
|
||||
Reference in new issue
Block a user