Update documentation

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -11,28 +11,30 @@ body:
       label: Is your feature request related to a problem? Please describe.
       description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
       placeholder: Related problem
-      value: "I'm always frustrated when [...]"
+      value: "## Motivation"
   - type: textarea
     id: solution
     attributes:
       label: Describe the solution you'd like
       description: A clear and concise description of what you want to happen.
       placeholder: The solution
-      value: "Possible solution: "
+      value: "## Description"
+    validations:
+      required: true
   - type: textarea
     id: alternatives
     attributes:
       label: Describe alternatives you've considered
       description: A clear and concise description of any alternative solutions or features you've considered.
       placeholder: Alternative solutions
-      value: "Temporary solution: "
+      value: "## Alternatives"
   - type: textarea
     id: additional-context
     attributes:
       label: Additional context
       description: Add any other context or screenshots about the feature request here.
       placeholder: Other context
-      value: "I want ..."
+      value: "## Additional Context"
   - type: checkboxes
     id: terms
     attributes:

.github/pull_request_template.md

@@ -2,13 +2,17 @@
 
 _A brief introduction to your changes..._
 
+# Motivation
+
+_Why is this needed..._
+
 # Description
 
 _Full description of your changes..._
 
 # Additional Context
 
-_Other context, such as version, dependencies, ..._
+_Other context such as version, dependencies, ..._
 
 ---
 

CONTRIBUTING.md

@@ -12,13 +12,32 @@ To start with [issues](https://github.com/Over-Run/overrungl/issues), we recomme
 
 ## Pull Requests
 
-Not sure when will review the pull request. Please note that the code must be formatted.
+We are not sure when we will review the pull request. Please note that the code must be formatted.
 
 ### Formatted Code
 
 The formatted code:
 
-- 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;
+- 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, like this below:
+  ```text
+  /*
+   * MIT License
+   *
+   * Copyright (c) 2022-2024 Overrun Organization
+   *
+   * Permission is hereby granted, free of charge, to any person obtaining a copy
+   * of this software and associated documentation files (the "Software"), to deal
+   * in the Software without restriction, including without limitation the rights
+   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+   * copies of the Software, and to permit persons to whom the Software is
+   * furnished to do so, subject to the following conditions:
+   *
+   * The above copyright notice and this permission notice shall be included in all
+   * copies or substantial portions of the Software.
+   */
+  ```
+  ;
 - The class names **MUST** be CamelCase;
 - The method and field names _should_ be camelCase;
 - Other rules specified by [.editorconfig](.editorconfig).

README.md

@@ -1,10 +1,9 @@
 # OverrunGL - Overrun Game Library
 
 ![License](https://img.shields.io/github/license/Over-Run/overrungl)
-[![GitHub contributors](https://img.shields.io/github/contributors/Over-Run/overrungl)](https://github.com/Over-Run/overrungl/graphs/contributors)
 
 ![Maven Central](https://img.shields.io/maven-central/v/io.github.over-run/overrungl)
-![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/io.github.over-run/overrungl?server=https%3A%2F%2Fs01.oss.sonatype.org%2F)
+![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/io.github.over-run/overrungl?server=https%3A%2F%2Fs01.oss.sonatype.org)
 
 [![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)
 [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8279/badge)](https://www.bestpractices.dev/projects/8279)

SECURITY.md

@@ -2,16 +2,17 @@
 
 ## Supported Versions
 
-We are currently working on 0.x versions, 
-and only the latest version will be supported.
+We are currently working on 0.x versions.
+
+Only the latest version will be supported.
 
 | Version | Supported          |
 |---------|--------------------|
 | 0.1.x   | :white_check_mark: |
 
 ## Reporting a Vulnerability
 
-You can report a vulnerability through [creating an issue](https://github.com/Over-Run/overrungl/security/advisories/new).
+You can report a vulnerability by [drafting advisory](https://github.com/Over-Run/overrungl/security/advisories/new).
 
 By reporting the vulnerability, you acknowledge that you have read and agree our [Code of Conduct](CODE_OF_CONDUCT.md).
 

build.gradle.kts

@@ -17,7 +17,6 @@ val projBranch: String by project
 val projLicenseYear: String by project
 val orgName: String by project
 val orgUrl: String by project
-val developers: String by project
 
 val jdkVersion: String by rootProject
 val jdkEnablePreview: String by rootProject
@@ -297,6 +296,14 @@ publishing.publications {
             name.set(orgName)
             url.set(orgUrl)
         }
+        developers {
+            developer {
+                id = "squid233"
+                url = "https://github.com/squid233"
+                organization = orgName
+                organizationUrl = orgUrl
+            }
+        }
         scm {
             connection.set("scm:git:https://github.com/${projVcs}.git")
             developerConnection.set("scm:git:https://github.com/${projVcs}.git")

doc/legal/README.md

@@ -9,6 +9,5 @@ We redistributed code from these libraries:
 Files:
 
 - 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)
-- 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)
 - 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)
 - 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

@@ -5,10 +5,7 @@ _Not Released Yet_
 This version includes the following features:
 
 - GLFW 3.4
-- OpenGL 1.0 ~ 4.6 functions and constants
-- OpenGL extension functions
-- OpenGL Loader
-- STB features introduced in README
-- C memory function
+- OpenGL 1.0 ~ 4.6 and extension functions and constants
+- stb features introduced in README
 - Native memory access for JOML
 - Native File Dialog Extended

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

@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2022-2023 Overrun Organization
+ * Copyright (c) 2022-2024 Overrun Organization
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

pom.xml

@@ -32,16 +32,14 @@
     <licenses>
         <license>
             <name>MIT</name>
-            <url>https://raw.githubusercontent.com/Over-Run/overrungl/0.x/LICENSE</url>
+            <url>https://raw.githubusercontent.com/Over-Run/overrungl/main/LICENSE</url>
             <distribution>repo</distribution>
         </license>
     </licenses>
 
     <developers>
         <developer>
             <id>squid233</id>
-            <name>squid233</name>
-            <email>513508220@qq.com</email>
             <url>https://github.com/squid233</url>
         </developer>
     </developers>