Initial Commit

Author: PotatoPresident

.editorconfig

@@ -0,0 +1,21 @@
+# https://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_size = 4
+indent_style = space
+trim_trailing_whitespace = true
+
+[*.java]
+max_line_length = 120
+
+[*.{json,yml}]
+indent_size = 2
+
+[*.md]
+max_line_length = 80
+trim_trailing_whitespace = false

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,131 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at [email]. All
+complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

.github/CONTRIBUTING.md

@@ -0,0 +1,141 @@
+# Contributing
+
+## Discussions
+
+Discussions are a great way to ask for help without undergoing the formalities
+of opening an issue. You are encouraged to use discussions where appropriate.
+
+* With a single question, you show where contributors can improve the user
+  experience
+
+## Issues
+
+Issues are an invaluable asset to the success of this project.
+
+* Ideas enable others to make meaningful contributions
+* Problems highlight where this project is lacking
+* Issues can help others debug their problems
+
+Thank you for creating them.
+
+## Pull Requests
+
+Pull requests are the best way to get your ideas into this repository's
+codebase.
+
+When deciding to merge a pull request, the following things are taken into
+account alongside the [Code of Conduct][codeofconduct]:
+
+#### 1. Does it state intent
+
+You should be clear with which problem you are trying to solve within your
+contribution.
+
+#### 2. Is it justified
+
+You should justify the way your change solves the problem, i.e. why this change
+is better. It may also be worth mentioning any alternate solutions considered
+but discarded.
+
+#### 3. Is it of quality
+
+There are no grammatical or spelling mistakes - it reads well.
+
+Try to make sure your explanation can be understood without external resources.
+
+Instead of giving a URL to a discussion, try to summarise the relevant points.
+
+## Branches
+
+A branch contains commits to be included in an
+aforementioned [pull request](#pull-requests).
+
+### Branching Strategy
+
+This project follows the [GitHub flow][github:flow] - a lightweight,
+branch-based workflow that supports teams and projects where deployments are
+made regularly.
+
+#### `main`
+
+At any given time, the latest code that exists in production can be found under
+the `main` branch.
+
+#### `next` / `next-major`
+
+An upcoming major release can be found under the `next` or `next-major`
+branches. For example, if `main` is currently on `v2.4.1`, the next major
+release is expected to be on `v3.0.0`.
+
+#### `beta` / `alpha`
+
+The latest Beta and Alpha releases can be found under the `beta` and `alpha`
+branches respectively. Their corresponding versions contain the `-beta`
+or `-alpha` suffixes.
+
+#### `+([0-9])?(.{+([0-9]),x}).x`
+
+Branches that match the given pattern are for maintenance releases, generally
+used for patching older versions of the codebase as outlined below.
+
+## Commits
+
+Many commits may form an aforementioned pull request.
+
+### Commit Messages
+
+This project adheres to [Conventional Commits][conventionalcommits] - a
+specification for adding human and machine-readable meaning to commit messages.
+
+It is worth noting that your commit messages will be used to build
+automated [changelogs][changelog]! Hence, code owners may choose to squash your
+commits in any pull requests to ensure they meet our standards outlined in the
+aforementioned Conventional Commits.
+
+## Versions
+
+This project follows the [Semantic Versioning][semver] specification.
+
+### Major Releases
+
+A new feature or fix may introduce a breaking change, this warrants a new major
+version. These releases are not backwards compatible.
+
+### Pre-releases
+
+As new features and breaking changes are developed, we may decide to deploy
+these only to our most dedicated users to get feedback. These releases are
+identified by a `-beta` or `-alpha` suffix in the version specifier.
+
+### Maintenance Releases
+
+Often, it makes sense to release important patches to older versions so those
+who cannot update due to strict policies may benefit. To track an older major
+version, look for its related branch that follows the
+pattern `+([0-9])?(.{+([0-9]),x}).x`, e.g. `2.x`.
+
+## Continuous Integration & Deployment (CI/CD)
+
+This project uses [GitHub Actions][github:actions] in tandem
+with [semantic-release][semantic-release] to automate building, testing and
+deploying new versions of the codebase.
+
+Please refer to the following [recipes][semantic-release:recipes] for triggering
+new releases.
+
+### How it works?
+
+When new commits make their way into one of the release branches outlined in
+the [Branching Strategy](#branching-strategy), a
+GitHub [workflow][workflow:publish] is triggered. This workflow in turn
+executes [semantic-release][semantic-release].
+
+[changelog]: ../CHANGELOG.md
+[codeofconduct]: CODE_OF_CONDUCT.md
+[conventionalcommits]: https://www.conventionalcommits.org/
+[github:actions]: https://github.com/features/actions
+[github:flow]: https://guides.github.com/introduction/flow
+[semantic-release]: https://github.com/semantic-release/semantic-release
+[semantic-release:recipes]: https://github.com/semantic-release/semantic-release/blob/v17.4.4/docs/recipes
+[semver]: https://semver.org/
+[workflow:publish]: workflows/publish.yml

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,56 @@
+name: Bug Report
+description: Report a bug
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before reporting a crash here, please make sure you are on the latest supported version.
+
+  - type: textarea
+    attributes:
+      label: Expected behavior
+      description: What you expected to see.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Observed/actual behavior
+      description: What you actually saw.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Steps/models to reproduce
+      description: This may include a screenshot, a video, or detailed instructions to help reconstruct the issue.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Version
+      description: Please provide the version of the mod you're running. This can be found in the file name of the mod jar.
+    validations:
+      required: true
+
+  - type: checkboxes
+    attributes:
+      label: Agreements
+      description: Please agree to the following.
+      options:
+        - label: I am running the latest version of the mod.
+          required: true
+        - label: My version of Minecraft is supported.
+          required: true
+        - label: I have searched for and ensured there isn't already an open issue regarding this.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Other
+      description: |
+        Please include other information that may be helpful below.
+        The more information we receive, the quicker and more effective we can be at finding the solution to the issue.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,14 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Wiki
+    url: https://github.com/axieum/fabric-example-mod/wiki
+    about: Please find helpful guides related to using the mod here
+  - name: GitHub Discussions
+    url: https://github.com/axieum/fabric-example-mod/discussions
+    about: Please ask and answer any questions regarding the mod here
+  - name: Join Discord
+    url: https://discord.gg/example
+    about: Please get involved with the mod's community here
+  - name: About Fabric
+    url: https://fabricmc.net/
+    about: Please find information regarding the Fabric mod loader here