ZXCmod/.github
2
1
Fork 0
mirror of https://github.com/ZXCmod/.github.git synced 2025-04-21 22:03:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

init

Browse Source
This commit is contained in:
STAM 2025-04-05 21:41:04 +03:00
parent 1d3077245d
commit ae91f8f11d
No known key found for this signature in database
GPG Key ID: 711526C6938897F1
15 changed files with 731 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
.github/FUNDING.yml vendored Normal file
View File

@ -0,0 +1,13 @@
# These are supported funding model platforms
#patreon: epicmorg
#ko_fi: epicmorg
custom: https://vk.com/zxcmod
#github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
#open_collective: # Replace with a single Open Collective username
#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
#community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
#liberapay: # Replace with a single Liberapay username
#issuehunt: # Replace with a single IssueHunt username
#otechie: # Replace with a single Otechie username
#custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

45
.github/ISSUE_TEMPLATE/bug.yml vendored Normal file
View File

@ -0,0 +1,45 @@
name: 🐞 Bug Report
description: A generic bug report
title: "[BUG]: "
labels: ["Type: 🐞 bug", "Status: 🖐 available"]
assignees:
- stamepicmorg
body:
- type: markdown
attributes:
value: 💖 Thanks for taking the time to fill out this bug report!
- type: input
id: contact
attributes:
label: 👉👈 Contact Details (optional)
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: 🤔 What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: A bug happened!
validations:
required: true
- type: textarea
id: additionalinfo
attributes:
label: ⚠️ Information
description: |
➡️ Your environment: OS ( 🪟 `Windows` or 🐧 `Linux`), OS Vetsion, etc.
render: shell
validations:
required: true
- type: textarea
id: logs
attributes:
label: 📄 Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: markdown
attributes:
value: Thanks for completing our form!

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: "EpicMorg - Main Site"
about: Dev Blog
url: https://ww.epicm.org/

30
.github/ISSUE_TEMPLATE/feature.yml vendored Normal file
View File

@ -0,0 +1,30 @@
name: 💡 New Feature
description: Suggest an idea for this project
title: "[Feature request]: "
labels: ["Engine: ⚙️ Independent", "Priority: ⚠️ medium", "OS: 💻 Independent", "Status: 🖐 available", "Type: 💡 feature request"]
assignees:
- stamepicmorg
body:
- type: markdown
attributes:
value: 💖 Thanks for taking the time to fill out this Feature request!
- type: input
id: contact-task
attributes:
label: 👉👈 Contact Details (optional)
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false
- type: textarea
id: have-idea
attributes:
label: 💡 Tell us more about your idea
description: Tell us what you expect from the project and the developers?
placeholder: Tell us about your idea!
value: I have an idea!
validations:
required: true
- type: markdown
attributes:
value: Thanks for completing our form!

28
.github/ISSUE_TEMPLATE/task.yml vendored Normal file
View File

@ -0,0 +1,28 @@
name: ⚗️ Task
description: Create some generic task for this project
title: "[TASK]: "
labels: ["Engine: ⚙️ Independent", "Priority: ⚠️ medium", "OS: 💻 Independent", "Status: 🖐 available", "Type: ⚗️ task"]
body:
- type: markdown
attributes:
value: 💖 Thanks for taking the time to fill out this Task!
- type: input
id: contact-feature
attributes:
label: 👉👈 Contact Details (optional)
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false
- type: textarea
id: have-task
attributes:
label: 📌 Tell us more about your task
description: Tell us what you want from the project and the developers?
placeholder: Tell us about your task!
value: I have an task!
validations:
required: true
- type: markdown
attributes:
value: Thanks for completing our form!

125
.github/labels.yml vendored Normal file
View File

@ -0,0 +1,125 @@
# Priority
- name: "Priority: 🔥 high"
description: "Tasks with high priority that require immediate attention."
color: "FF5733"
- name: "Priority: ⚠️ medium"
description: "Medium priority tasks that should be addressed soon."
color: "FFC300"
- name: "Priority: 🕒 low"
description: "Low priority tasks that can be postponed for the future."
color: "C4C4C4"
# Resolution
- name: "Resolution: ✂️ duplicate"
description: "Duplicate of an existing task or issue."
color: "dc7935"
- name: "Resolution: ❇️ resolved"
description: "The issue resolved, but not fully closed."
color: "35dc79"
- name: "Resolution: 🚫 wontfix"
description: "The issue will not be fixed; the task is closed."
color: "a7551d"
- name: "Resolution: ❓ invalid"
description: "Invalid task, lacking sufficient information or incorrect format."
color: "C4C4C4"
# Type
- name: "Type: ⚗️ task"
description: "Generic task."
color: "35dc79"
- name: "Type: 🐞 bug"
description: "An error that needs fixing."
color: "FF5733"
- name: "Type: ⚡ performance"
description: "Optimization of system or code performance."
color: "FFC107"
- name: "Type: 🔒 security"
description: "Vulnerabilities or issues related to security."
color: "DC3545"
- name: "Type: 🛠️ maintenance"
description: "Tasks related to technical debt, infrastructure upkeep."
color: "FFD700"
- name: "Type: ⚙️ infrastructure"
description: "Tasks for maintaining or improving system infrastructure."
color: "B0C4DE"
- name: "Type: 🚀 enhancement"
description: "Improvement or addition of a new feature."
color: "28A745"
- name: "Type: 💡 feature request"
description: "Request for a new feature or enhancement."
color: "FF851B"
- name: "Type: 📚 documentation"
description: "Tasks related to updating or improving documentation."
color: "007BFF"
- name: "Type: 🛠️ refactor"
description: "Refactoring code without adding new functionality."
color: "6F42C1"
- name: "Type: ✅ test"
description: "Related to testing and verification of code."
color: "20C997"
- name: "Type: 🧹 chore"
description: "Routine tasks, maintenance, or non-user-facing changes."
color: "FAD8C7"
- name: "Type: 🛑 dependency"
description: "Pull requests that update a dependency file."
color: "C7FAD8"
# Status
- name: "Status: 🖐 available"
description: "Task currently opened."
color: "45DC35"
- name: "Status: 🚧 in progress"
description: "Task currently being worked on."
color: "FFC300"
- name: "Status: ⛔️ blocked"
description: "Issue is blocked by some reason."
color: "F44336"
- name: "Status: 👀 needs review"
description: "Requires code or changes review."
color: "17A2B8"
- name: "Status: 🗣️ needs feedback"
description: "Comments or feedback needed from the community or team."
color: "6C757D"
- name: "Status: ✅ done"
description: "The issue done and closed."
color: "FF5733"
- name: "Status: 🕹️ on hold"
description: "Task temporarily on hold."
color: "C4C4C4"
- name: "Status: ⚠️ triage"
description: "A label used to categorize issues for prioritization and organization."
color: "6C757D"
- name: "Status: 🕐 pending"
description: "Issue is penging list."
color: "987743"
- name: "Status: 🛟 help wanted"
description: "Help wanted."
color: "FAC7E9"
- name: "Status: 📦 closed"
description: "Issue is closed with some resolution."
color: "A2C4C9"
- name: "Status: 🎮 testing"
description: "Issue in testing stage."
color: "E69138"
# Difficulty
- name: "Difficulty: 🟢 easy"
description: "Easy task that can be completed quickly."
color: "28A745"
- name: "Difficulty: 🟡 medium"
description: "Task of medium difficulty requiring moderate effort."
color: "FFC300"
- name: "Difficulty: 🔴 hard"
description: "Difficult task requiring significant resources and time."
color: "DC3545"
# OS
- name: "OS: 💻 Independent"
description: "Case do not refer to any OS."
color: "999999"
- name: "OS: 🐧 Linux"
description: "Case refers to Linux."
color: "6fa8dc"
- name: "OS: 🪟 Windows"
description: "Case refers to Windows."
color: "8e7cc3"

13
.github/pull_request_template.md vendored Normal file
View File

@ -0,0 +1,13 @@
## Purpose
_Describe the problem or feature in addition to a link to the issues._
## Approach
_How does this change address the problem?_
#### Open Questions and Pre-Merge TODOs
- [ ] Use github checklists. When solved, check the box and explain the answer.
## Learning
_Describe the research stage_
_Links to blog posts, patterns, libraries or addons used to solve this problem_

46
.github/workflows/sync-with-gitlab.yml vendored Normal file
View File

@ -0,0 +1,46 @@
name: Automatic sync with read-only mirrors
on:
# push:
# branches:
# - main
schedule:
- cron: '42 0 * * 0'
workflow_dispatch:
jobs:
mirror:
runs-on: ubuntu-latest
strategy:
matrix:
repo:
- {github: "https://github.com/ZXCmod/.github.git", bitbucket: "git@bitbucket.org:zxcmod/.github.git" , gitlab: "git@gitlab.com:zxcmod/dot-github.git" }
steps:
- name: Set up SSH key
env:
SSH_PRIVATE_KEY: ${{ secrets.DEPLOY_KEY }}
run: |
mkdir -p ~/.ssh
echo "$SSH_PRIVATE_KEY" > ~/.ssh/id_ed25519
chmod 600 ~/.ssh/id_ed25519
ssh-keyscan -t rsa,ed25519 github.com >> ~/.ssh/known_hosts
ssh-keyscan -t rsa,ed25519 gitlab.com >> ~/.ssh/known_hosts
ssh-keyscan -t rsa,ed25519 bitbucket.org >> ~/.ssh/known_hosts
- name: Clone repository as mirror
run: |
git clone --mirror ${{ matrix.repo.github }} repo-mirror
- name: Push to BitBucket
run: |
cd repo-mirror
git remote set-url origin ${{ matrix.repo.bitbucket }}
git push --mirror --force
- name: Push to GitLab
run: |
cd repo-mirror
git remote set-url origin ${{ matrix.repo.gitlab }}
git push --mirror --force

28
.github/workflows/sync_labels.yml vendored Normal file
View File

@ -0,0 +1,28 @@
name: Sync labels
on:
workflow_dispatch:
inputs:
repo:
description: 'Repository'
required: true
type: choice
options:
# System
- ZXCmod/.github
# Projects
- ZXCmod/ZXCmod
- ZXCmod/ZXCmod-info
jobs:
sync:
name: Sync ${{ inputs.repo }} labels
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: micnncim/action-label-syncer@v1
with:
manifest: .github/labels.yml
repository: |
${{ inputs.repo }}
token: ${{ secrets.ZXC_LABELS_PAT }}

18
CHANGELOG.md Normal file
View File

@ -0,0 +1,18 @@
# [Lorem](https://github.com/EpicMorg/.github) Changelog
**Lorem** ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
---
## [`1.3.0.149`](https://github.com/EpicMorg/metamod-r/releases/tag/1.3.0.149) - 2024-04-23
### Fixed
- Some here
### Changed
- Some here
### Added
- Some here
**Full Changelog**: [1.3.0.138...1.3.0.149](https://github.com/EpicMorg/metamod-r/compare/1.3.0.138...1.3.0.149)

132
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,132 @@
# 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 email 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
[INSERT CONTACT METHOD].
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.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
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.1]: https://www.contributor-covenant.org/version/2/1/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

181
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,181 @@
# Contributing Guidelines
*Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged!* :octocat:
> **This guide serves to set clear expectations for everyone involved with the project so that we can improve it together while also creating a welcoming space for everyone to participate. Following these guidelines will help ensure a positive experience for contributors and maintainers.**
## :book: Code of Conduct
Please review our [Code of Conduct](CODE_OF_CONDUCT.md). It is in effect at all times. We expect it to be honored by everyone who contributes to this project. Acting like an asshole will not be tolerated.
## :bulb: Asking Questions
See our [Support Guide](SUPPORT.md). In short, GitHub issues are not the appropriate place to debug your specific project, but should be reserved for filing bugs and feature requests.
## :inbox_tray: Opening an Issue
Before [creating an issue](https://help.github.com/en/github/managing-your-work-on-github/creating-an-issue), check if you are using the latest version of the project. If you are not up-to-date, see if updating fixes your issue first.
### :lock: Reporting Security Issues
Review our [Security Policy](https://github.com/jessesquires/.github/blob/main/SECURITY.md). **Do not** file a public issue for security vulnerabilities.
### :beetle: Bug Reports and Other Issues
A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate a well-written, thorough bug report. :v:
In short, since you are most likely a developer, **provide a ticket that you would like to receive**.
- **Review the documentation and [Support Guide](SUPPORT.md)** before opening a new issue.
- **Do not open a duplicate issue!** Search through existing issues to see if your issue has previously been reported. If your issue exists, comment with any additional information you have. You may simply note "I have this problem too", which helps prioritize the most common problems and requests.
- **Prefer using [reactions](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)**, not comments, if you simply want to "+1" an existing issue.
- **Fully complete the provided issue template.** The bug report template requests all the information we need to quickly and efficiently address your issue. Be clear, concise, and descriptive. Provide as much information as you can, including steps to reproduce, stack traces, compiler errors, library versions, OS versions, and screenshots (if applicable).
- **Use [GitHub-flavored Markdown](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax).** Especially put code blocks and console outputs in backticks (```). This improves readability.
## :love_letter: Feature Requests
Feature requests are welcome! While we will consider all requests, we cannot guarantee your request will be accepted. We want to avoid [feature creep](https://en.wikipedia.org/wiki/Feature_creep). Your idea may be great, but also out-of-scope for the project. If accepted, we cannot make any commitments regarding the timeline for implementation and release. However, you are welcome to submit a pull request to help!
- **Do not open a duplicate feature request.** Search for existing feature requests first. If you find your feature (or one very similar) previously requested, comment on that issue.
- **Fully complete the provided issue template.** The feature request template asks for all necessary information for us to begin a productive conversation.
- Be precise about the proposed outcome of the feature and how it relates to existing features. Include implementation details if possible.
## :mag: Triaging Issues
You can triage issues which may include reproducing bug reports or asking for additional information, such as version numbers or reproduction instructions. Any help you can provide to quickly resolve an issue is very much appreciated!
## :repeat: Submitting Pull Requests
We **love** pull requests! Before [forking the repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) and [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests) for non-trivial changes, it is usually best to first open an issue to discuss the changes, or discuss your intended approach for solving the problem in the comments for an existing issue.
For most contributions, after your first pull request is accepted and merged, you will be [invited to the project](https://help.github.com/en/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository) and given **push access**. :tada:
*Note: All contributions will be licensed under the project's license.*
- **Smaller is better.** Submit **one** pull request per bug fix or feature. A pull request should contain isolated changes pertaining to a single bug fix or feature implementation. **Do not** refactor or reformat code that is unrelated to your change. It is better to **submit many small pull requests** rather than a single large one. Enormous pull requests will take enormous amounts of time to review, or may be rejected altogether.
- **Coordinate bigger changes.** For large and non-trivial changes, open an issue to discuss a strategy with the maintainers. Otherwise, you risk doing a lot of work for nothing!
- **Prioritize understanding over cleverness.** Write code clearly and concisely. Remember that source code usually gets written once and read often. Ensure the code is clear to the reader. The purpose and logic should be obvious to a reasonably skilled developer, otherwise you should add a comment that explains it.
- **Follow existing coding style and conventions.** Keep your code consistent with the style, formatting, and conventions in the rest of the code base. When possible, these will be enforced with a linter. Consistency makes it easier to review and modify in the future.
- **Include test coverage.** Add unit tests or UI tests when possible. Follow existing patterns for implementing tests.
- **Update the example project** if one exists to exercise any new functionality you have added.
- **Add documentation.** Document your changes with code doc comments or in existing guides.
- **Update the CHANGELOG** for all enhancements and bug fixes. Include the corresponding issue number if one exists, and your GitHub username. (example: "- Fixed crash in profile view. #123 @jessesquires")
- **Use the repo's default branch.** Branch from and [submit your pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) to the repo's default branch. Usually this is `main`, but it could be `dev`, `develop`, or `master`.
- **[Resolve any merge conflicts](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)** that occur.
- **Promptly address any CI failures**. If your pull request fails to build or pass tests, please push another commit to fix it.
- When writing comments, use properly constructed sentences, including punctuation.
- Use spaces, not tabs.
## :memo: Writing Commit Messages
Please [write a great commit message](https://chris.beams.io/posts/git-commit/).
1. Separate subject from body with a blank line
1. Limit the subject line to 50 characters
1. Capitalize the subject line
1. Do not end the subject line with a period
1. Use the imperative mood in the subject line (example: "Fix networking issue")
1. Wrap the body at about 72 characters
1. Use the body to explain **why**, *not what and how* (the code shows that!)
1. If applicable, prefix the title with the relevant component name. (examples: "[Docs] Fix typo", "[Profile] Fix missing avatar")
```
[TAG] Short summary of changes in 50 chars or less
Add a more detailed explanation here, if necessary. Possibly give
some background about the issue being fixed, etc. The body of the
commit message can be several paragraphs. Further paragraphs come
after blank lines and please do proper word-wrap.
Wrap it to about 72 characters or so. In some contexts,
the first line is treated as the subject of the commit and the
rest of the text as the body. The blank line separating the summary
from the body is critical (unless you omit the body entirely);
various tools like `log`, `shortlog` and `rebase` can get confused
if you run the two together.
Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how or what. The code explains
how or what. Reviewers and your future self can read the patch,
but might not understand why a particular solution was implemented.
Are there side effects or other unintuitive consequences of this
change? Here's the place to explain them.
- Bullet points are okay, too
- A hyphen or asterisk should be used for the bullet, preceded
by a single space, with blank lines in between
Note the fixed or relevant GitHub issues at the end:
Resolves: #123
See also: #456, #789
```
## :white_check_mark: Code Review
- **Review the code, not the author.** Look for and suggest improvements without disparaging or insulting the author. Provide actionable feedback and explain your reasoning.
- **You are not your code.** When your code is critiqued, questioned, or constructively criticized, remember that you are not your code. Do not take code review personally.
- **Always do your best.** No one writes bugs on purpose. Do your best, and learn from your mistakes.
- Kindly note any violations to the guidelines specified in this document.
## :nail_care: Coding Style
Consistency is the most important. Following the existing style, formatting, and naming conventions of the file you are modifying and of the overall project. Failure to do so will result in a prolonged review process that has to focus on updating the superficial aspects of your code, rather than improving its functionality and performance.
For example, if all private properties are prefixed with an underscore `_`, then new ones you add should be prefixed in the same way. Or, if methods are named using camelcase, like `thisIsMyNewMethod`, then do not diverge from that by writing `this_is_my_new_method`. You get the idea. If in doubt, please ask or search the codebase for something similar.
When possible, style and format will be enforced with a linter.
## :medal_sports: Certificate of Origin
*Developer's Certificate of Origin 1.1*
By making a contribution to this project, I certify that:
> 1. The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
> 1. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
> 1. The contribution was provided directly to me by some other person who certified (1), (2) or (3) and I have not modified it.
> 1. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
## [No Brown M&M's](https://en.wikipedia.org/wiki/Van_Halen#Contract_riders)
If you are reading this, bravo dear user and (hopefully) contributor for making it this far! You are awesome. :100:
To confirm that you have read this guide and are following it as best as possible, **include this emoji at the top** of your issue or pull request: :black_heart: `:black_heart:`
## :pray: Credits
Written by [@wopox1337](https://github.com/wopox1337) from [@jessesquires's](https://github.com/jessesquires/.github/blob/main/CONTRIBUTING.md).
**Please feel free to adopt this guide in your own projects. Fork it wholesale or remix it for your needs.**
*Many of the ideas and prose for the statements in this document were based on or inspired by work from the following communities:*
- [Alamofire](https://github.com/Alamofire/Alamofire/blob/master/CONTRIBUTING.md)
- [CocoaPods](https://github.com/CocoaPods/CocoaPods/blob/master/CONTRIBUTING.md)
- [Docker](https://github.com/moby/moby/blob/master/CONTRIBUTING.md)
- [Linux](https://elinux.org/Developer_Certificate_Of_Origin)
*We commend them for their efforts to facilitate collaboration in their projects.*

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2009 EpicMorg
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

15
SECURITY.md Normal file
View File

@ -0,0 +1,15 @@
# Security Policy
## Supported <...> Versions
| Version | Supported | Notes |
| ------- | ------- | ------- |
| 1.2.3.4 | :white_check_mark: | - |
| 3.3.3.3 | :white_check_mark: | x86_64 only |
| 2.3.3.0 | :warning: | x86_64 only, partially |
## Reporting a Vulnerability
1. Open `Issues` tab [here](https://github.com/EpicMorg/.github/issues).
2. Select `CVE Report`.
3. Publish `CVE Report`.
4. Thank you :heart:

31
SUPPORT.md Normal file
View File

@ -0,0 +1,31 @@
# Support and Help
Need help getting started or using a project? Here's how.
## How to get help
Generally, we do not use GitHub as a support forum. For any usage questions that are not specific to the project itself, please ask on [Stack Overflow](https://stackoverflow.com) instead. By doing so, you are more likely to quickly solve your problem, and you will allow anyone else with the same question to find the answer. This also allows maintainers to focus on improving the project for others.
Please seek support in the following ways:
1. :book: **Read the documentation and other guides** for the project to see if you can figure it out on your own. These should be located in a root `docs/` directory. If there is an example project, explore that to learn how it works to see if you can answer your question.
1. :bulb: **Search for answers and ask questions on [Stack Overflow](https://stackoverflow.com).** This is the most appropriate place for debugging issues specific to your use of the project, or figuring out how to use the project in a specific way.
1. :memo: As a **last resort**, you may open an issue on GitHub to ask for help. However, please clearly explain what you are trying to do, and list what you have already attempted to solve the problem. Provide code samples, but **do not** attach your entire project for someone else to debug. Review our [contributing guidelines](CONTRIBUTING.md).
## What NOT to do
Please **do not** do any the following:
1. :x: Do not reach out to the author or contributor on Twitter (or other social media) by tweeting or sending a direct message.
1. :x: Do not email the author or contributor.
1. :x: Do not open duplicate issues or litter an existing issue with +1's.
These are not appropriate avenues for seeking help or support with an open-source project. Please follow the guidelines in the previous section. Public questions get public answers, which benefits everyone in the community. ✌️
## Customer Support
We do not provide any sort of "customer support" for open-source projects.