Skip to content

Commit 6633704

Browse files
FalsePatternFalsePattern
committed
github community boilerplate
1 parent e3ad88b commit 6633704

File tree

7 files changed

+196
-0
lines changed

7 files changed

+196
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Crash
2+
description: The game has a problem when FalsePatternLib is present
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
assignees:
6+
- falsepattern
7+
body:
8+
# Recommended for precise context
9+
- type: input
10+
id: modpack
11+
attributes:
12+
label: Modpack (Optional)
13+
description: If you used the mod in a modpack, you should include the pack's exact name and version here to make debugging easier.
14+
validations:
15+
required: false
16+
# Essential
17+
- type: textarea
18+
id: logs
19+
attributes:
20+
label: Game log
21+
description: Attach the fml-client-latest.log file here.
22+
validations:
23+
required: true
24+
# Essential
25+
- type: textarea
26+
id: description
27+
attributes:
28+
label: Description
29+
description: Describe how and when you experience this bug.
30+
validations:
31+
required: false

‎.github/ISSUE_TEMPLATE/compat-request.yml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: Compatibility Request
2+
description: If you tested FalsePatternLib with another mod and it crashes or has weird bugs, you can ask for a compatibility patch through this.
3+
title: "[Compatibility Request]: "
4+
labels: ["compat-request"]
5+
assignees:
6+
- falsepattern
7+
body:
8+
# Essential
9+
- type: input
10+
id: modname
11+
attributes:
12+
label: Other mod's name
13+
description: The name of the other mod
14+
validations:
15+
required: true
16+
# Essential
17+
- type: input
18+
id: modurl
19+
attributes:
20+
label: Other mod's homepage
21+
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.
22+
validations:
23+
required: true
24+
# Important
25+
- type: dropdown
26+
id: license
27+
attributes:
28+
label: Other mod's license
29+
description: What license does the other mod have? (Open source mods are easier to write compatibility patches for)
30+
options:
31+
- AGPLv3
32+
- AGPLv2
33+
- GPLv3
34+
- GPLv2
35+
- LGPLv3
36+
- LGPLv2
37+
- Apache 2.0
38+
- Beerware
39+
- BSD 3-Clause
40+
- BSD 2-Clause
41+
- EPL 2.0
42+
- MIT
43+
- MPL 2.0
44+
- Unlicense
45+
- WTFPL
46+
- Other open source license (please specify in the description)
47+
- All Rights Reserved
48+
validations:
49+
required: true
50+
# Recommended
51+
- type: textarea
52+
id: logs
53+
attributes:
54+
label: Game log
55+
description: Attach the fml-client-latest.log file here.
56+
validations:
57+
required: true
58+
# Recommended
59+
- type: textarea
60+
id: description
61+
attributes:
62+
label: Description
63+
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.
64+
validations:
65+
required: false
66+
# Modify this after every added patch
67+
# - type: checkboxes
68+
# id: existingpatches
69+
# attributes:
70+
# label: Existing Patches
71+
# description: The mods below already have compatibility patches. If you're experiencing issues with those, submit either a crash or a bug report!
72+
# options:
73+
# - label: This request is not for X
74+
# required: true
75+
# - label: This request is not for Y
76+
# required: true
77+
# - label: This request is not for Z
78+
# required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Use this to disable people making non-templated issues.
2+
blank_issues_enabled: false

‎CODE_OF_CONDUCT.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Code of Merit
2+
3+
1. The project creators, lead developers, core team, constitute
4+
the managing members of the project and have final say in every decision
5+
of the project, technical or otherwise, including overruling previous decisions.
6+
There are no limitations to this decisional power.
7+
8+
2. Contributions are an expected result of your membership on the project.
9+
Don't expect others to do your work or help you with your work forever.
10+
11+
3. All members have the same opportunities to seek any challenge they want
12+
within the project.
13+
14+
4. Authority or position in the project will be proportional
15+
to the accrued contribution. Seniority must be earned.
16+
17+
5. Software is evolutive: the better implementations must supersede lesser
18+
implementations. Technical advantage is the primary evaluation metric.
19+
20+
6. This is a space for technical prowess; topics outside of the project
21+
will not be tolerated.
22+
23+
7. Non technical conflicts will be discussed in a separate space. Disruption
24+
of the project will not be allowed.
25+
26+
8. Individual characteristics, including but not limited to,
27+
body, sex, sexual preference, race, language, religion, nationality,
28+
or political preferences are irrelevant in the scope of the project and
29+
will not be taken into account concerning your value or that of your contribution
30+
to the project.
31+
32+
9. Discuss or debate the idea, not the person.
33+
34+
10. There is no room for ambiguity: Ambiguity will be met with questioning;
35+
further ambiguity will be met with silence. It is the responsibility
36+
of the originator to provide requested context.
37+
38+
11. If something is illegal outside the scope of the project, it is illegal
39+
in the scope of the project. This Code of Merit does not take precedence over
40+
governing law.
41+
42+
12. This Code of Merit governs the technical procedures of the project not the
43+
activities outside of it.
44+
45+
13. Participation on the project equates to agreement of this Code of Merit.
46+
47+
14. No objectives beyond the stated objectives of this project are relevant
48+
to the project. Any intent to deviate the project from its original purpose
49+
of existence will constitute grounds for remedial action which may include
50+
expulsion from the project.
51+
52+
This document is adapted from the Code of Merit, version 1.0.
53+
See: https://codeofmerit.org/.

‎CONTRIBUTING.MD‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# How to contribute
2+
3+
## Describe everything properly
4+
* Make sure to properly fill out the pull request and issue templates
5+
* Ambiguous changes with no explanation will be rejected.
6+
7+
## Make sure to follow existing coding conventions
8+
9+
The most important conventions to upkeep if you don't want your PR rejected:
10+
* 4 spaces per indent level for code, 2 spaces per indent level for json, yaml, etc.
11+
* Parentheses/Brackes/Braces open on the same line, not on a new line
12+
* Method arguments are lists, not paragraphs. Either ALL arguments go on the same line, or every argument goes a SEPARATE line.
13+
* Not everyone has an ultrawide monitor. Try to keep lines below 120 characters in length.
14+
* Do not reformat existing code. Reformatting is done exclusively by the maintainers.
15+
* Annotations have one parameter per line, no exceptions
16+
* Do not pollute the repo with IDE-specific configuration files.

‎PULL_REQUEST_TEMPLATE.MD‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Describe your changes
2+
3+
## The issue this PR is connected to (if applicable)
4+
5+
## What kind of PR is this?
6+
7+
Delete the ones that do not apply.
8+
- [ ] Bug fix (non-breaking change which fixes an issue)
9+
- [ ] New feature (non-breaking change which adds functionality)
10+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
11+
12+
## Checklist before requesting a review
13+
- [ ] I have tested the code locally and it works
14+
- [ ] I followed the requirements set in the contribution document

‎README.MD‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,5 @@ The contents of the [util](src/main/java/com/falsepattern/lib/util) package so f
1919
Anything annotated with [@StableAPI](src/main/java/com/falsepattern/lib/StableAPI.java) is guaranteed to not change in patch versions.
2020

2121
### This project WILL NOT be ported to any version beyond 1.7.10, don't even ask
22+
23+
[![POOP badge](https://raw.githubusercontent.com/gist/poop-person/991e80f390384bbeef09d208bff208f4/raw/a9ef83add84a70f2202896c2d81117ff7b169be1/poop-badge.svg)](https://gist.github.com/poop-person/991e80f390384bbeef09d208bff208f4)

0 commit comments

Comments
 (0)