Skip to content

Commit 885d8a3

Browse files
squid233squid233
committed
Update documentation
1 parent 709fc9a commit 885d8a3

File tree

10 files changed

+49
-23
lines changed

10 files changed

+49
-23
lines changed

‎.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,30 @@ body:
1111
label: Is your feature request related to a problem? Please describe.
1212
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1313
placeholder: Related problem
14-
value: "I'm always frustrated when [...]"
14+
value: "## Motivation"
1515
- type: textarea
1616
id: solution
1717
attributes:
1818
label: Describe the solution you'd like
1919
description: A clear and concise description of what you want to happen.
2020
placeholder: The solution
21-
value: "Possible solution: "
21+
value: "## Description"
22+
validations:
23+
required: true
2224
- type: textarea
2325
id: alternatives
2426
attributes:
2527
label: Describe alternatives you've considered
2628
description: A clear and concise description of any alternative solutions or features you've considered.
2729
placeholder: Alternative solutions
28-
value: "Temporary solution: "
30+
value: "## Alternatives"
2931
- type: textarea
3032
id: additional-context
3133
attributes:
3234
label: Additional context
3335
description: Add any other context or screenshots about the feature request here.
3436
placeholder: Other context
35-
value: "I want ..."
37+
value: "## Additional Context"
3638
- type: checkboxes
3739
id: terms
3840
attributes:

‎.github/pull_request_template.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,17 @@
22

33
_A brief introduction to your changes..._
44

5+
# Motivation
6+
7+
_Why is this needed..._
8+
59
# Description
610

711
_Full description of your changes..._
812

913
# Additional Context
1014

11-
_Other context, such as version, dependencies, ..._
15+
_Other context such as version, dependencies, ..._
1216

1317
---
1418

‎CONTRIBUTING.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,32 @@ To start with [issues](https://github.com/Over-Run/overrungl/issues), we recomme
1212

1313
## Pull Requests
1414

15-
Not sure when will review the pull request. Please note that the code must be formatted.
15+
We are not sure when we will review the pull request. Please note that the code must be formatted.
1616

1717
### Formatted Code
1818

1919
The formatted code:
2020

21-
- Except auto-generated files, Java files header **MUST** contain the copy of [LICENSE](LICENSE). The copy **MUST** be ended without an empty line and commented with block style;
21+
- Except auto-generated files, Java files header **MUST** contain the copy of [LICENSE](LICENSE).
22+
The copy **MUST** be ended without an empty line and commented with block style, like this below:
23+
```text
24+
/*
25+
* MIT License
26+
*
27+
* Copyright (c) 2022-2024 Overrun Organization
28+
*
29+
* Permission is hereby granted, free of charge, to any person obtaining a copy
30+
* of this software and associated documentation files (the "Software"), to deal
31+
* in the Software without restriction, including without limitation the rights
32+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
33+
* copies of the Software, and to permit persons to whom the Software is
34+
* furnished to do so, subject to the following conditions:
35+
*
36+
* The above copyright notice and this permission notice shall be included in all
37+
* copies or substantial portions of the Software.
38+
*/
39+
```
40+
;
2241
- The class names **MUST** be CamelCase;
2342
- The method and field names _should_ be camelCase;
2443
- Other rules specified by [.editorconfig](.editorconfig).

‎README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# OverrunGL - Overrun Game Library
22

33
![License](https://img.shields.io/github/license/Over-Run/overrungl)
4-
[![GitHub contributors](https://img.shields.io/github/contributors/Over-Run/overrungl)](https://github.com/Over-Run/overrungl/graphs/contributors)
54

65
![Maven Central](https://img.shields.io/maven-central/v/io.github.over-run/overrungl)
7-
![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/io.github.over-run/overrungl?server=https%3A%2F%2Fs01.oss.sonatype.org%2F)
6+
![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/io.github.over-run/overrungl?server=https%3A%2F%2Fs01.oss.sonatype.org)
87

98
[![Java CI with Gradle](https://github.com/Over-Run/overrungl/actions/workflows/gradle.yml/badge.svg?event=push)](https://github.com/Over-Run/overrungl/actions/workflows/gradle.yml)
109
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8279/badge)](https://www.bestpractices.dev/projects/8279)

‎SECURITY.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,17 @@
22

33
## Supported Versions
44

5-
We are currently working on 0.x versions,
6-
and only the latest version will be supported.
5+
We are currently working on 0.x versions.
6+
7+
Only the latest version will be supported.
78

89
| Version | Supported |
910
|---------|--------------------|
1011
| 0.1.x | :white_check_mark: |
1112

1213
## Reporting a Vulnerability
1314

14-
You can report a vulnerability through [creating an issue](https://github.com/Over-Run/overrungl/security/advisories/new).
15+
You can report a vulnerability by [drafting advisory](https://github.com/Over-Run/overrungl/security/advisories/new).
1516

1617
By reporting the vulnerability, you acknowledge that you have read and agree our [Code of Conduct](CODE_OF_CONDUCT.md).
1718

‎build.gradle.kts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ val projBranch: String by project
1717
val projLicenseYear: String by project
1818
val orgName: String by project
1919
val orgUrl: String by project
20-
val developers: String by project
2120

2221
val jdkVersion: String by rootProject
2322
val jdkEnablePreview: String by rootProject
@@ -297,6 +296,14 @@ publishing.publications {
297296
name.set(orgName)
298297
url.set(orgUrl)
299298
}
299+
developers {
300+
developer {
301+
id = "squid233"
302+
url = "https://github.com/squid233"
303+
organization = orgName
304+
organizationUrl = orgUrl
305+
}
306+
}
300307
scm {
301308
connection.set("scm:git:https://github.com/${projVcs}.git")
302309
developerConnection.set("scm:git:https://github.com/${projVcs}.git")

‎doc/legal/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,5 @@ We redistributed code from these libraries:
99
Files:
1010

1111
- modules/lwjgl/core/src/main/java/org/lwjgl/system/MemoryManage.java -> [modules/overrungl.core/src/main/java/overrungl/util/DebugAllocator.java](../../modules/overrungl.core/src/main/java/overrungl/util/DebugAllocator.java)
12-
- modules/lwjgl/core/src/main/java/org/lwjgl/system/MemoryStack.java -> [modules/overrungl.core/src/main/java/overrungl/util/MemoryStack.java](../../modules/overrungl.core/src/main/java/overrungl/util/MemoryStack.java)
1312
- modules/lwjgl/core/src/main/java9/org/lwjgl/system/StackWalkUtil.java -> [modules/overrungl.core/src/main/java/overrungl/util/StackWalkUtil.java](../../modules/overrungl.core/src/main/java/overrungl/util/StackWalkUtil.java)
1413
- modules/samples/src/test/java/org/lwjgl/demo/util/IOUtil.java -> [modules/samples/src/test/java/overrungl/demo/util/IOUtil.java](../../modules/samples/src/test/java/overrungl/demo/util/IOUtil.java)

‎doc/notes/0.x/0.1.0.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,7 @@ _Not Released Yet_
55
This version includes the following features:
66

77
- GLFW 3.4
8-
- OpenGL 1.0 ~ 4.6 functions and constants
9-
- OpenGL extension functions
10-
- OpenGL Loader
11-
- STB features introduced in README
12-
- C memory function
8+
- OpenGL 1.0 ~ 4.6 and extension functions and constants
9+
- stb features introduced in README
1310
- Native memory access for JOML
1411
- Native File Dialog Extended

‎modules/overrungl.core/src/main/java/overrungl/util/StackWalkUtil.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* MIT License
33
*
4-
* Copyright (c) 2022-2023 Overrun Organization
4+
* Copyright (c) 2022-2024 Overrun Organization
55
*
66
* Permission is hereby granted, free of charge, to any person obtaining a copy
77
* of this software and associated documentation files (the "Software"), to deal

‎pom.xml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,14 @@
3232
<licenses>
3333
<license>
3434
<name>MIT</name>
35-
<url>https://raw.githubusercontent.com/Over-Run/overrungl/0.x/LICENSE</url>
35+
<url>https://raw.githubusercontent.com/Over-Run/overrungl/main/LICENSE</url>
3636
<distribution>repo</distribution>
3737
</license>
3838
</licenses>
3939

4040
<developers>
4141
<developer>
4242
<id>squid233</id>
43-
<name>squid233</name>
44-
<email>[email protected]</email>
4543
<url>https://github.com/squid233</url>
4644
</developer>
4745
</developers>

0 commit comments

Comments
 (0)