mirror of
https://github.com/Zandercraft/TechnicFlux.git
synced 2026-10-30 04:49:20 +00:00
Merge pull request #4 from Zandercraft/project/documents-and-configs
Bring project-related documents up to date.
This commit is contained in:
Zander
GitHub
31
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
31
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
---
|
||||||
|
name: Bug Report
|
||||||
|
about: Report an issue/bug that affects TechnicFlux
|
||||||
|
labels: bug
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Describe the bug**
|
||||||
|
A clear and concise description of what the bug is.
|
||||||
|
|
||||||
|
**To Reproduce**
|
||||||
|
Steps to reproduce the behavior:
|
||||||
|
1. Go to '...'
|
||||||
|
2. Click on '....'
|
||||||
|
3. Scroll down to '....'
|
||||||
|
4. See error
|
||||||
|
|
||||||
|
**Expected behavior**
|
||||||
|
A clear and concise description of what you expected to happen.
|
||||||
|
|
||||||
|
**Screenshots**
|
||||||
|
If applicable, add screenshots to help explain your problem.
|
||||||
|
|
||||||
|
**Desktop (please complete the following information):**
|
||||||
|
- OS: [e.g. iOS]
|
||||||
|
- Browser: [e.g. chrome, safari]
|
||||||
|
- TechnicFlux Version: [e.g. 22]
|
||||||
|
- Node.js Version: [e.g. 20.7.0]
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context about the problem here.
|
||||||
18
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
18
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
name: Feature Request
|
||||||
|
about: Suggest an idea for TechnicFlux
|
||||||
|
labels: enhancement
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Is your feature request related to a problem? Please describe.**
|
||||||
|
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||||
|
|
||||||
|
**Describe the solution you'd like**
|
||||||
|
A clear and concise description of what you want to happen.
|
||||||
|
|
||||||
|
**Describe alternatives you've considered**
|
||||||
|
A clear and concise description of any alternative solutions or features you've considered.
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context or screenshots about the feature request here.
|
||||||
46
CHANGELOG.md
Normal file
46
CHANGELOG.md
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
All changes to TechnicFlux are documented here. The latest version is at the top.
|
||||||
|
|
||||||
|
A version is marked as Unreleased if it is currently on the dev branch and is still undergoing development. It will be
|
||||||
|
assigned a version number and release date with the next release of TechnicFlux.
|
||||||
|
**Important:** When contributing, ensure that you update this file to include a list of all the changes that you have made.
|
||||||
|
|
||||||
|
**Follow the below format for each new version:**
|
||||||
|
```
|
||||||
|
## [vX.X.X or 'Unreleased'] - yyyy-mm-dd
|
||||||
|
|
||||||
|
Write a brief overview of the update and everything that is significant about it here.
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- [#12](https://github.com/Zandercraft/TechnicFlux/issues/12) -
|
||||||
|
Short description of feature added based on an issue. ([ZandercraftGames](https://github.com/ZandercraftGames)).
|
||||||
|
- Short description of feature added ([ZandercraftGames](https://github.com/ZandercraftGames)).
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- [#13](https://github.com/Zandercraft/TechnicFlux/issues/13) -
|
||||||
|
Short description of feature changed based on an issue. ([ZandercraftGames](https://github.com/ZandercraftGames)).
|
||||||
|
- Short description of feature changed. ([ZandercraftGames](https://github.com/ZandercraftGames)).
|
||||||
|
### Bug fixes
|
||||||
|
- [#14](https://github.com/Zandercraft/TechnicFlux/issues/14) -
|
||||||
|
Short description of bug fixed based on an issue. ([ZandercraftGames](https://github.com/ZandercraftGames)).
|
||||||
|
- Short description of bug fixed. ([ZandercraftGames](https://github.com/ZandercraftGames)).
|
||||||
|
### Security
|
||||||
|
- [CVE-123456](<CVE LINK>) -
|
||||||
|
Fixed a security vulnerability. ([ZandercraftGames](https://github.com/ZandercraftGames)).
|
||||||
|
### Deprecated
|
||||||
|
- [#14](https://github.com/Zandercraft/TechnicFlux/issues/14) -
|
||||||
|
Short description of deprecated feature based on an issue. ([ZandercraftGames](https://github.com/ZandercraftGames)).
|
||||||
|
- Short description of deprecated feature. ([ZandercraftGames](https://github.com/ZandercraftGames)).
|
||||||
|
### Removed
|
||||||
|
- [#15](https://github.com/Zandercraft/TechnicFlux/issues/15) -
|
||||||
|
Short description of feature removed based on an issue. ([ZandercraftGames](https://github.com/ZandercraftGames)).
|
||||||
|
- Short description of feature removed. ([ZandercraftGames](https://github.com/ZandercraftGames)).
|
||||||
|
### Additional Update Instructions (only include if applicable)
|
||||||
|
Here you would describe any additional instructions/steps required to update to this version of TechnicFlux and why they
|
||||||
|
are necessary.
|
||||||
|
1. Example step 1
|
||||||
|
2. Example step 2
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
95
CODE_OF_CONDUCT.md
Normal file
95
CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,95 @@
|
|||||||
|
# Code of Conduct - TechnicFlux
|
||||||
|
All maintainers and contributors of the TechnicFlux project are expected to follow this code of conduct within the
|
||||||
|
context(s) described in [Scope](#scope).
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make
|
||||||
|
participation in our project and our community a harassment-free experience for everyone and to consider everyone's
|
||||||
|
opinions, contributions, and feedback in an objective manner.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to a positive environment for our
|
||||||
|
community include:
|
||||||
|
|
||||||
|
* Demonstrating understanding and kindness toward other people
|
||||||
|
* Being respectful of differing opinions and viewpoints
|
||||||
|
* 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:
|
||||||
|
|
||||||
|
* Trolling, insulting or derogatory comments, and personal attacks
|
||||||
|
* Public or private harassment
|
||||||
|
* Publishing others' private information without their explicit permission
|
||||||
|
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||||
|
|
||||||
|
|
||||||
|
## Our Responsibilities
|
||||||
|
|
||||||
|
Project maintainers 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, or harmful.
|
||||||
|
|
||||||
|
Project maintainers 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 [security@zandercraft.ca](mailto:security@zandercraft.ca). 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, sustained inappropriate behavior,
|
||||||
|
harassment or aggression toward an individual, destruction of community resources, or malicious/illegal activity.
|
||||||
|
|
||||||
|
**Consequence**: A permanent ban from any sort of public interaction within the community.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/).
|
||||||
78
CONTRIBUTING.md
Normal file
78
CONTRIBUTING.md
Normal file
@@ -0,0 +1,78 @@
|
|||||||
|
# Contribution Guidelines
|
||||||
|
Thank you so much taking the time to contribute! ❤️
|
||||||
|
|
||||||
|
Contributions are what make the open source community such an amazing place to be, learn, inspire, and create. Any
|
||||||
|
contributions you make are **greatly appreciated**. Our goal as a project is to be open to feedback and contributions,
|
||||||
|
fostering an active community in which you can truly be involved in improving TechnicFlux and keeping it bug-free.
|
||||||
|
|
||||||
|
> If you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support
|
||||||
|
> the project and show your appreciation:
|
||||||
|
> - ⭐ Star the project
|
||||||
|
> - 💬 Tweet about/share it
|
||||||
|
> - 📜 Refer to TechnicFlux in your own project/modpack's description
|
||||||
|
> - 🗣️ Tell your friends about TechnicFlux
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [Code of Conduct](#code-of-conduct)
|
||||||
|
- [I Have a Question](#i-have-a-question)
|
||||||
|
- [I Want To Contribute](#i-want-to-contribute)
|
||||||
|
- [Creating A Pull Request](#creating-a-pull-request)
|
||||||
|
|
||||||
|
## Code of Conduct
|
||||||
|
|
||||||
|
This project and everyone participating in it are governed by the
|
||||||
|
[TechnicFlux Code of Conduct](./CODE_OF_CONDUCT.md).
|
||||||
|
By participating, you are expected to uphold this code. Please report unacceptable behavior
|
||||||
|
to [security@zandercraft.ca](mailto:security@zandercraft.ca).
|
||||||
|
|
||||||
|
## I Have a Question
|
||||||
|
|
||||||
|
> If you want to ask a question, we assume that you have read all available [Documentation](https://github.com/Zandercraft/TechnicFlux/wiki).
|
||||||
|
|
||||||
|
Before you ask a question, it is best to search for existing [Issues](https://github.com/Zandercraft/TechnicFlux/issues)
|
||||||
|
that might help you. In case you have found a suitable issue and still need clarification, you can write your question
|
||||||
|
in this issue. It is also advisable to search the internet for answers first.
|
||||||
|
|
||||||
|
If you then still feel the need to ask a question and need clarification, we recommend the following:
|
||||||
|
|
||||||
|
- Open an [Issue](https://github.com/Zandercraft/TechnicFlux/issues/new).
|
||||||
|
- Provide as much context as you can about your issue.
|
||||||
|
- Make sure to fill out all required fields in the template.
|
||||||
|
|
||||||
|
We will then take care of the issue as soon as possible.
|
||||||
|
|
||||||
|
## I Want To Contribute
|
||||||
|
|
||||||
|
> ### Legal Notice
|
||||||
|
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the
|
||||||
|
> necessary rights to the content and that the content you contribute may be provided under the project license.
|
||||||
|
>
|
||||||
|
> ### ⚠️ Security Issues
|
||||||
|
> You must never report security-related issues, vulnerabilities or bugs including sensitive information to the issue
|
||||||
|
> tracker, or elsewhere in public. Instead, see [SECURITY.md](./SECURITY.md) for instructions on reporting this type of
|
||||||
|
> issue.
|
||||||
|
|
||||||
|
* If you have suggestions for adding or removing features, feel free to [open an issue](https://github.com/Zandercraft/TechnicFlux/issues/new)
|
||||||
|
to discuss it, or directly [create a pull request](#creating-a-pull-request).
|
||||||
|
* Please make sure you check your spelling and grammar.
|
||||||
|
* Make sure your changes comply with StandardJS code style by running `standard --fix` and fixing any issues.
|
||||||
|
* Ensure that you update the README.md to match any changes your PR includes.
|
||||||
|
* Ensure that you update the latest Unreleased entry in [CHANGELOG.md](./CHANGELOG.md) with your changes.
|
||||||
|
* Create individual PRs for each suggestion, bug-fix, or enhancement.
|
||||||
|
* Use new branches on your fork to separate different changes _(see [Creating A Pull Request](#creating-a-pull-request))_.
|
||||||
|
|
||||||
|
### Creating A Pull Request
|
||||||
|
1. Fork the Project
|
||||||
|
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
||||||
|
3. Commit your Changes w/ Descriptive Message (`git commit -m 'Added AmazingFeature...'`)
|
||||||
|
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
||||||
|
5. Open a New Pull Request
|
||||||
|
|
||||||
|
> When naming your forks, please prefix your fork names with the type of change they include:
|
||||||
|
> **Bug Fixes** - `bugfix/`
|
||||||
|
> **New Features** - `feature/`
|
||||||
|
> **Removed Features** - `removal/`
|
||||||
|
> **Deprecations** - `deprecation/`
|
||||||
|
> **Project-Related Changes** - `project/` _includes grammar, document changes, GitHub actions, etc._
|
||||||
|
> _This makes it much easier to distinguish the purpose of a branch by its name._
|
||||||
32
SECURITY.md
Normal file
32
SECURITY.md
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
# Security Policy
|
||||||
|
|
||||||
|
## Supported Versions
|
||||||
|
|
||||||
|
The table below details which versions of TechnicFlux are supported with security updates.
|
||||||
|
Currently, as it stands, we only support the latest official release and dev branches with security updates. **Older
|
||||||
|
releases are not supported.**
|
||||||
|
|
||||||
|
**Please ensure that you are running the latest available version of TechnicFlux to have the latest security updates and
|
||||||
|
bug fixes.**
|
||||||
|
|
||||||
|
| Version | Supported |
|
||||||
|
|---------|-----------|
|
||||||
|
| release | ✅ |
|
||||||
|
| dev | ✅ |
|
||||||
|
| v1.0.0 | ✅ |
|
||||||
|
| <v1.0.0 | ❌ |
|
||||||
|
|
||||||
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
|
If you think that you have discovered a security vulnerability in TechnicFlux, please do not create a public issue.
|
||||||
|
Instead, contact us using one of the contact methods below.
|
||||||
|
|
||||||
|
In the case that the vulnerability is discovered to be valid, we will discuss a plan to address the issue and a CVE
|
||||||
|
will be requested as we push the update out.
|
||||||
|
|
||||||
|
| Method | Contact Information |
|
||||||
|
|--------------------|----------------------------------------------------------------------------------------------|
|
||||||
|
| Github (Preferred) | [Report a vulnerability](https://github.com/Zandercraft/TechnicFlux/security/advisories/new) |
|
||||||
|
| Email (Preferred) | security@zandercraft.ca |
|
||||||
|
| Discord | @zandercraft |
|
||||||
|
|
||||||
Reference in New Issue
Block a user