upstream/FalsePatternLib
2
0 Fork 0
mirror of https://github.com/FalsePattern/FalsePatternLib.git synced 2026-11-11 19:37:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

github community boilerplate

Browse Source
This commit is contained in:
FalsePattern committed 2022-05-22 00:03:58 +02:00
1 parent e3ad88bcfe
commit 6633704c5a
7 files changed
+196
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

.github/ISSUE_TEMPLATE/bug.yml
+31
View File
@@ -0,0 +1,31 @@
name: Crash
description: The game has a problem when FalsePatternLib is present
title: "[Bug]: "
labels: ["bug"]
assignees:
- falsepattern
body:
# Recommended for precise context
- type: input
id: modpack
attributes:
label: Modpack (Optional)
description: If you used the mod in a modpack, you should include the pack's exact name and version here to make debugging easier.
validations:
required: false
# Essential
- type: textarea
id: logs
attributes:
label: Game log
description: Attach the fml-client-latest.log file here.
validations:
required: true
# Essential
- type: textarea
id: description
attributes:
label: Description
description: Describe how and when you experience this bug.
validations:
required: false
.github/ISSUE_TEMPLATE/compat-request.yml
+78
View File
@@ -0,0 +1,78 @@
name: Compatibility Request
description: If you tested FalsePatternLib with another mod and it crashes or has weird bugs, you can ask for a compatibility patch through this.
title: "[Compatibility Request]: "
labels: ["compat-request"]
assignees:
- falsepattern
body:
# Essential
- type: input
id: modname
attributes:
label: Other mod's name
description: The name of the other mod
validations:
required: true
# Essential
- type: input
id: modurl
attributes:
label: Other mod's homepage
description: A link to the main site where the other mod is hosted. Preferrably the original website of a mod, but a modrinth/curseforge/whatever page is also acceptable. Do not post a raw download link, those requests will be ignored.
validations:
required: true
# Important
- type: dropdown
id: license
attributes:
label: Other mod's license
description: What license does the other mod have? (Open source mods are easier to write compatibility patches for)
options:
- AGPLv3
- AGPLv2
- GPLv3
- GPLv2
- LGPLv3
- LGPLv2
- Apache 2.0
- Beerware
- BSD 3-Clause
- BSD 2-Clause
- EPL 2.0
- MIT
- MPL 2.0
- Unlicense
- WTFPL
- Other open source license (please specify in the description)
- All Rights Reserved
validations:
required: true
# Recommended
- type: textarea
id: logs
attributes:
label: Game log
description: Attach the fml-client-latest.log file here.
validations:
required: true
# Recommended
- type: textarea
id: description
attributes:
label: Description
description: Describe any visual errors that appear, and attach screenshots of them. You can leave this empty if it's a crash without any visible stuff.
validations:
required: false
# Modify this after every added patch
# - type: checkboxes
# id: existingpatches
# attributes:
# label: Existing Patches
# description: The mods below already have compatibility patches. If you're experiencing issues with those, submit either a crash or a bug report!
# options:
# - label: This request is not for X
# required: true
# - label: This request is not for Y
# required: true
# - label: This request is not for Z
# required: true
.github/ISSUE_TEMPLATE/config.yml
+2
View File
@@ -0,0 +1,2 @@
# Use this to disable people making non-templated issues.
blank_issues_enabled: false
CODE_OF_CONDUCT.md
+53
View File
@@ -0,0 +1,53 @@
# Code of Merit
1. The project creators, lead developers, core team, constitute
the managing members of the project and have final say in every decision
of the project, technical or otherwise, including overruling previous decisions.
There are no limitations to this decisional power.
2. Contributions are an expected result of your membership on the project.
Don't expect others to do your work or help you with your work forever.
3. All members have the same opportunities to seek any challenge they want
within the project.
4. Authority or position in the project will be proportional
to the accrued contribution. Seniority must be earned.
5. Software is evolutive: the better implementations must supersede lesser
implementations. Technical advantage is the primary evaluation metric.
6. This is a space for technical prowess; topics outside of the project
will not be tolerated.
7. Non technical conflicts will be discussed in a separate space. Disruption
of the project will not be allowed.
8. Individual characteristics, including but not limited to,
body, sex, sexual preference, race, language, religion, nationality,
or political preferences are irrelevant in the scope of the project and
will not be taken into account concerning your value or that of your contribution
to the project.
9. Discuss or debate the idea, not the person.
10. There is no room for ambiguity: Ambiguity will be met with questioning;
further ambiguity will be met with silence. It is the responsibility
of the originator to provide requested context.
11. If something is illegal outside the scope of the project, it is illegal
in the scope of the project. This Code of Merit does not take precedence over
governing law.
12. This Code of Merit governs the technical procedures of the project not the
activities outside of it.
13. Participation on the project equates to agreement of this Code of Merit.
14. No objectives beyond the stated objectives of this project are relevant
to the project. Any intent to deviate the project from its original purpose
of existence will constitute grounds for remedial action which may include
expulsion from the project.
This document is adapted from the Code of Merit, version 1.0.
See: https://codeofmerit.org/.
CONTRIBUTING.MD
+16
View File
@@ -0,0 +1,16 @@
# How to contribute
## Describe everything properly
* Make sure to properly fill out the pull request and issue templates
* Ambiguous changes with no explanation will be rejected.
## Make sure to follow existing coding conventions
The most important conventions to upkeep if you don't want your PR rejected:
* 4 spaces per indent level for code, 2 spaces per indent level for json, yaml, etc.
* Parentheses/Brackes/Braces open on the same line, not on a new line
* Method arguments are lists, not paragraphs. Either ALL arguments go on the same line, or every argument goes a SEPARATE line.
* Not everyone has an ultrawide monitor. Try to keep lines below 120 characters in length.
* Do not reformat existing code. Reformatting is done exclusively by the maintainers.
* Annotations have one parameter per line, no exceptions
* Do not pollute the repo with IDE-specific configuration files.
PULL_REQUEST_TEMPLATE.MD
+14
View File
@@ -0,0 +1,14 @@
## Describe your changes
## The issue this PR is connected to (if applicable)
## What kind of PR is this?
Delete the ones that do not apply.
- [ ] 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)
## Checklist before requesting a review
- [ ] I have tested the code locally and it works
- [ ] I followed the requirements set in the contribution document
README.MD
+2
View File
@@ -19,3 +19,5 @@ The contents of the [util](src/main/java/com/falsepattern/lib/util) package so f
Anything annotated with [@StableAPI](src/main/java/com/falsepattern/lib/StableAPI.java) is guaranteed to not change in patch versions.
### This project WILL NOT be ported to any version beyond 1.7.10, don't even ask
[![POOP badge](https://raw.githubusercontent.com/gist/poop-person/991e80f390384bbeef09d208bff208f4/raw/a9ef83add84a70f2202896c2d81117ff7b169be1/poop-badge.svg)](https://gist.github.com/poop-person/991e80f390384bbeef09d208bff208f4)