diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 96aa06c3f2..5210f50bff 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -8,8 +8,9 @@ body: label: Issue Checklist description: Be sure to complete these steps to increase the chances of your issue being addressed! options: - - label: I have properly named my issue + - label: I have read the pinned [Issues Guide](https://github.com/FunkinCrew/Funkin/issues/4050) - label: I have checked the Issues/Discussions pages to see if my issue has already been reported + - label: I have properly named my issue - type: dropdown attributes: @@ -41,7 +42,7 @@ body: attributes: label: Version description: Which version are you playing on? The game version is in the bottom left corner of the main menu. - placeholder: ex. 0.5.0 + placeholder: ex. 0.5.3 validations: required: true diff --git a/.github/ISSUE_TEMPLATE/charting.yml b/.github/ISSUE_TEMPLATE/charting.yml new file mode 100644 index 0000000000..3c1e689ce0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/charting.yml @@ -0,0 +1,71 @@ +name: Charting Issue +description: Report an issue with the placement of notes in the game. +labels: ["type: charting issue", "status: pending triage"] +title: "Charting Issue: " +body: + - type: checkboxes + attributes: + label: Issue Checklist + description: Be sure to complete these steps to increase the chances of your issue being addressed! + options: + - label: I have read the pinned [Issues Guide](https://github.com/FunkinCrew/Funkin/issues/4050) + - label: I have checked the Issues/Discussions pages to see if my issue has already been reported + - label: I have properly named my issue + + - type: dropdown + attributes: + label: Platform + description: Which platform are you playing on? + options: + - Newgrounds (Web/HTML5) + - Itch.io (Web/HTML5) + - Itch.io (Downloadable Build) - Windows + - Itch.io (Downloadable Build) - MacOS + - Itch.io (Downloadable Build) - Linux + - Compiled from GitHub Source Code + validations: + required: true + + - type: dropdown + attributes: + label: Browser + description: (Web/HTML5 users only) Which browser are you playing on? + options: + - Google Chrome + - Microsoft Edge + - Firefox + - Opera + - Safari + - Other (Specify in Description field) + + - type: input + attributes: + label: Version + description: Which version are you playing on? The game version is in the bottom left corner of the main menu. + placeholder: ex. 0.5.3 + validations: + required: true + + - type: markdown + attributes: + value: "## Describe the charting issue(s)." + + - type: markdown + attributes: + value: "### Please do not report issues from other engines. These must be reported in their respective repositories." + + - type: textarea + attributes: + label: Location + description: Where did you find the issue(s)? Include the name of the song, the variation, the difficulty, the time/section of the song, and any images or videos. + placeholder: ex. Cocoa Erect on Erect/Nightmare difficulties at Section 30 + validations: + required: true + + - type: textarea + attributes: + label: Description + description: Why do you believe this is an issue? Is a note at the wrong time, a hold note too short/long, or something else? + placeholder: Describe the charting issue(s) here... + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/compiling.yml b/.github/ISSUE_TEMPLATE/compiling.yml new file mode 100644 index 0000000000..c9e364c3e5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/compiling.yml @@ -0,0 +1,59 @@ +name: Compiling Help +description: Report an issue with compiling the game. +labels: ["type: compilation help", "status: pending triage"] +title: "Compiling Help: " +body: + - type: checkboxes + attributes: + label: Issue Checklist + description: Be sure to complete these steps to increase the chances of your issue being addressed! + options: + - label: I have read the pinned [Issues Guide](https://github.com/FunkinCrew/Funkin/issues/4050) + - label: I have followed the [Compiling Guide](https://github.com/FunkinCrew/Funkin/blob/main/docs/COMPILING.md) and the [Troubleshooting Guide](https://github.com/FunkinCrew/Funkin/blob/main/docs/TROUBLESHOOTING.md) + - label: I have checked the Issues/Discussions pages to see if my issue has already been reported + - label: I have properly named my issue + + - type: dropdown + attributes: + label: Platform + description: Which platform are you compiling for? + options: + - Web/HTML5 + - Desktop (Windows) + - Desktop (Mac) + - Desktop (Linux) + - Other + validations: + required: true + + - type: input + attributes: + label: Version + description: Which version are you compiling? The game version is in the bottom left corner of the main menu or in the project.hxp file. + placeholder: ex. 0.5.3 + validations: + required: true + + - type: markdown + attributes: + value: "## Describe your compiling issue." + + - type: markdown + attributes: + value: "### Please do not report issues from other engines. These must be reported in their respective repositories." + + - type: textarea + attributes: + label: Console Output + description: Paste any errors or warnings from the console here. + placeholder: Paste output here... + validations: + required: true + + - type: textarea + attributes: + label: Context + description: Provide as much detail as you can. Did you modify any code? Provide any relevant images or videos. + placeholder: Describe the context here... + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/crash.yml b/.github/ISSUE_TEMPLATE/crash.yml index 3e8fb08dd3..4f49289978 100644 --- a/.github/ISSUE_TEMPLATE/crash.yml +++ b/.github/ISSUE_TEMPLATE/crash.yml @@ -8,8 +8,9 @@ body: label: Issue Checklist description: Be sure to complete these steps to increase the chances of your issue being addressed! options: - - label: I have properly named my issue + - label: I have read the pinned [Issues Guide](https://github.com/FunkinCrew/Funkin/issues/4050) - label: I have checked the Issues/Discussions pages to see if my issue has already been reported + - label: I have properly named my issue - type: dropdown attributes: @@ -41,7 +42,7 @@ body: attributes: label: Version description: Which version are you playing on? The game version is in the bottom left corner of the main menu. - placeholder: ex. 0.5.0 + placeholder: ex. 0.5.3 validations: required: true diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml index dfb4ace959..108279534d 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -8,8 +8,9 @@ body: label: Issue Checklist description: Be sure to complete these steps to increase the chances of your suggestion being considered! options: - - label: I have properly named my enhancement + - label: I have read the pinned [Issues Guide](https://github.com/FunkinCrew/Funkin/issues/4050) - label: I have checked the Issues/Discussions pages to see if my enhancement has already been suggested + - label: I have properly named my enhancement - type: textarea attributes: diff --git a/.github/changed-lines-count-labeler.yml b/.github/changed-lines-count-labeler.yml index 1de00e62f8..9b2f338ce2 100644 --- a/.github/changed-lines-count-labeler.yml +++ b/.github/changed-lines-count-labeler.yml @@ -1,12 +1,12 @@ -# Add 'small' to any changes below 10 lines -small: +# Add 'size: small' to any changes below 10 lines +'size: small': max: 9 -# Add 'medium' to any changes between 10 and 100 lines -medium: +# Add 'size: medium' to any changes between 10 and 100 lines +'size: medium': min: 10 max: 99 -# Add 'large' to any changes of at least 100 lines -large: +# Add 'size: large' to any changes of at least 100 lines +'size: large': min: 100 diff --git a/.github/label-actions.yml b/.github/label-actions.yml index a99d17660f..ef7448ab26 100644 --- a/.github/label-actions.yml +++ b/.github/label-actions.yml @@ -7,21 +7,23 @@ comment: > This issue is a duplicate. Please direct all discussion to the original issue. # Close the issue - close: true + close: false # Set a close reason - close-reason: 'not planned' + # close-reason: 'not planned' # Remove other status labels unlabel: - 'status: accepted' - 'status: bug reproduced' - 'status: cannot reproduce' - 'status: needs clarification' + - 'status: needs r&d' - 'status: needs revision' - 'status: pending pull request' - 'status: pending triage' - 'status: planned' - 'status: rejected' - 'status: resolved' + - 'status: resolved internally' - 'status: reviewing internally' - 'status: stale' prs: @@ -29,6 +31,27 @@ comment: > This pull request is a duplicate. Please direct all discussion to the original pull request. # Close the pull request + close: false + # Remove other status labels + unlabel: + - 'status: accepted' + - 'status: bug reproduced' + - 'status: cannot reproduce' + - 'status: needs clarification' + - 'status: needs r&d' + - 'status: needs revision' + - 'status: pending pull request' + - 'status: pending triage' + - 'status: planned' + - 'status: rejected' + - 'status: resolved' + - 'status: resolved internally' + - 'status: reviewing internally' + - 'status: stale' + +'status: stale': + issues: + # Close the issue close: true # Set a close reason close-reason: 'not planned' @@ -37,15 +60,36 @@ - 'status: accepted' - 'status: bug reproduced' - 'status: cannot reproduce' + - 'status: duplicate' + - 'status: needs clarification' + - 'status: needs r&d' + - 'status: needs revision' + - 'status: pending pull request' + - 'status: pending triage' + - 'status: planned' + - 'status: rejected' + - 'status: resolved' + - 'status: resolved internally' + - 'status: reviewing internally' + prs: + # Close the pull request + close: true + # Remove other status labels + unlabel: + - 'status: accepted' + - 'status: bug reproduced' + - 'status: cannot reproduce' + - 'status: duplicate' - 'status: needs clarification' + - 'status: needs r&d' - 'status: needs revision' - 'status: pending pull request' - 'status: pending triage' - 'status: planned' - 'status: rejected' - 'status: resolved' + - 'status: resolved internally' - 'status: reviewing internally' - - 'status: stale' 'status: rejected': issues: @@ -60,18 +104,18 @@ - 'status: cannot reproduce' - 'status: duplicate' - 'status: needs clarification' + - 'status: needs r&d' - 'status: needs revision' - 'status: pending pull request' - 'status: pending triage' - 'status: planned' - 'status: resolved' + - 'status: resolved internally' - 'status: reviewing internally' - 'status: stale' prs: # Close the pull request close: true - # Set a close reason - close-reason: 'not planned' # Remove other status labels unlabel: - 'status: accepted' @@ -79,11 +123,13 @@ - 'status: cannot reproduce' - 'status: duplicate' - 'status: needs clarification' + - 'status: needs r&d' - 'status: needs revision' - 'status: pending pull request' - 'status: pending triage' - 'status: planned' - 'status: resolved' + - 'status: resolved internally' - 'status: reviewing internally' - 'status: stale' @@ -100,10 +146,12 @@ - 'status: cannot reproduce' - 'status: duplicate' - 'status: needs clarification' + - 'status: needs r&d' - 'status: needs revision' - 'status: pending pull request' - 'status: pending triage' - 'status: planned' - 'status: rejected' + - 'status: resolved internally' - 'status: reviewing internally' - 'status: stale' diff --git a/.github/labeler.yml b/.github/labeler.yml index 9cf784f4ca..414df5a31e 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -1,11 +1,18 @@ # Add Documentation tag to PR's changing markdown files, or anything in the docs folder -Documentation: +'pr: documentation': - changed-files: - any-glob-to-any-file: - docs/* - '**/*.md' # Add Haxe tag to PR's changing haxe code files -Haxe: +'pr: haxe': - changed-files: - any-glob-to-any-file: '**/*.hx' + +# Add GitHub tag to PR's changing yml files, or anything in the .github folder +'pr: github': +- changed-files: + - any-glob-to-any-file: + - github/* + - '**/*.yml' diff --git a/.github/workflows/label-pull-request-on-create.yml b/.github/workflows/label-pull-request-on-create.yml new file mode 100644 index 0000000000..94620657d4 --- /dev/null +++ b/.github/workflows/label-pull-request-on-create.yml @@ -0,0 +1,19 @@ +name: "Pull Request Labeler 2 (Runs on PR creation)" +on: + pull_request_target: + types: + - opened + +jobs: + # Apply `status: pending triage` to newly created pull requests + apply-pending-triage: + permissions: + contents: read + pull-requests: write + runs-on: ubuntu-latest + steps: + - name: Apply "status pending triage" to new pull requests + uses: actions-ecosystem/action-add-labels@v1 + with: + token: ${{ secrets.GITHUB_TOKEN }} + labels: "status: pending triage" diff --git a/LICENSE.md b/LICENSE.md index f7c1c42e98..68a0cba218 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -8,7 +8,7 @@ All Rights Reserved. "Friday Night Funkin'" and the "Friday Night Funkin'" logo You can view the `funkin-assets` license here: (https://github.com/FunkinCrew/funkin.assets/blob/main/LICENSE.md) ## Apache 2.0 License - +``` Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ @@ -210,3 +210,4 @@ You can view the `funkin-assets` license here: (https://github.com/FunkinCrew/fu WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. +``` diff --git a/README.md b/README.md index 29077d7f15..9239d266c1 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ To learn how to install the necessary dependencies and compile the game from sou # Contributing -Please check out our [Contributor's guide](./CONTRIBUTORS.md) on how you can actively participate in the development of Friday Night Funkin'. +You can actively participate in the development of Friday Night Funkin' by opening a [bug report](https://github.com/FunkinCrew/Funkin/issues) or submitting a [code contribution](https://github.com/FunkinCrew/Funkin/pulls)! # Modding