diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..477e061 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +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, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at developer@epicm.org. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..cb742ee --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before making a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Process + +1. Ensure any install or build dependencies are removed before the end of the layer when doing a + build. +2. Update the README.md with details of changes to the interface, this includes new environment + variables, exposed ports, useful file locations and container parameters. +3. Increase the version numbers in any examples files and the README.md to the new version that this + Pull Request would represent. +4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you + do not have permission to do that, you may request the second reviewer to merge it for you. diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..b7e7b12 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,13 @@ +# These are supported funding model platforms +patreon: epicmorg +ko_fi: epicmorg +custom: https://ko-fi.com/alexz696 + +#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'] diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..d41b607 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,27 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: 'bug, Regular Priority' +assignees: 'stamepicmorg' + +--- + +**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. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/cve_report.md b/.github/ISSUE_TEMPLATE/cve_report.md new file mode 100644 index 0000000..c69f58d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/cve_report.md @@ -0,0 +1,18 @@ +--- +name: CVE report +about: Create a report of some CVE +title: '[CVE] ' +labels: 'CVE, High Priority' +assignees: 'stamepicmorg' + +--- +**CVE number or URL** + +**Describe** +A clear and concise description of what the CVE is. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..982d2cd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,21 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: 'Feature request, help wanted' +assignees: 'stamepicmorg' +milestone: 'Due 2021 🙏' + +--- + +**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. diff --git a/.github/ISSUE_TEMPLATE/task_generic.md b/.github/ISSUE_TEMPLATE/task_generic.md new file mode 100644 index 0000000..4afb970 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task_generic.md @@ -0,0 +1,17 @@ +--- +name: Generic task +about: Create a generic task +title: '' +labels: 'task, Regular Priority' +assignees: 'stamepicmorg' + +--- + +**Describe** +A clear and concise description of what the bug is. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..c7f8007 --- /dev/null +++ b/.github/pull_request_template.md @@ -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_ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..1d02ece --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +# CHANGELOG + +* `1.0.0.0.` - First release. \ No newline at end of file diff --git a/LICENSE b/LICENSE.md similarity index 96% rename from LICENSE rename to LICENSE.md index 17c3a6e..5335ce0 100644 --- a/LICENSE +++ b/LICENSE.md @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 EpicMorg: Main +Copyright (c) 2018-2022 EpicMorg: Main Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 64449fd..98e84b4 100644 --- a/README.md +++ b/README.md @@ -1 +1,23 @@ -# SourceSDK.ENV.Editor \ No newline at end of file +# SourceSDK.ENV.Editor [![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/B0B81CUI4) + +# [![Activity](https://img.shields.io/github/commit-activity/m/EpicMorg/SourceSDK.ENV.Editor?label=commits&style=flat-square)](https://github.com/EpicMorg/SourceSDK.ENV.Editor/commits) [![GitHub issues](https://img.shields.io/github/issues/EpicMorg/SourceSDK.ENV.Editor.svg?style=popout-square)](https://github.com/EpicMorg/SourceSDK.ENV.Editor/issues) [![GitHub forks](https://img.shields.io/github/forks/EpicMorg/SourceSDK.ENV.Editor.svg?style=popout-square)](https://github.com/EpicMorg/SourceSDK.ENV.Editor/network) [![GitHub stars](https://img.shields.io/github/stars/EpicMorg/SourceSDK.ENV.Editor.svg?style=popout-square)](https://github.com/EpicMorg/SourceSDK.ENV.Editor/stargazers) [![Size](https://img.shields.io/github/repo-size/EpicMorg/SourceSDK.ENV.Editor?label=size&style=flat-square)](https://github.com/EpicMorg/SourceSDK.ENV.Editor/archive/master.zip) [![Release](https://img.shields.io/github/v/release/EpicMorg/SourceSDK.ENV.Editor?style=flat-square)](https://github.com/EpicMorg/SourceSDK.ENV.Editor/releases) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3658/badge)](https://bestpractices.coreinfrastructure.org/projects/3658) [![CodeScene System Mastery](https://codescene.io/projects/6535/status-badges/system-mastery)](https://codescene.io/projects/6535) [![GitHub license](https://img.shields.io/github/license/EpicMorg/SourceSDK.ENV.Editor.svg?style=popout-square)](LICENSE.md) [![Changelog](https://img.shields.io/badge/Changelog-yellow.svg?style=popout-square)](CHANGELOG.md) + +## Description +Manage your SourceSDK envs. + +# Reauerments +* `Windows 7-11` +* `dotnet6` + +## Preview + +![](https://rawcdn.githack.com/EpicMorg/SourceSDK.ENV.Editor/cbf034d866febd4ba87005cd2344bf1b46372a18/.github/images/preview1.png) + +![](https://rawcdn.githack.com/EpicMorg/SourceSDK.ENV.Editor/cbf034d866febd4ba87005cd2344bf1b46372a18/.github/images/preview2.png) + + +# Stargazers +[![Stargazers repo roster for @EpicMorg/SourceSDK.ENV.Editor](https://reporoster.com/stars/dark/EpicMorg/SourceSDK.ENV.Editor)](https://github.com/EpicMorg/SourceSDK.ENV.Editor/stargazers) + +# Forkers +[![Forkers repo roster for @EpicMorg/SourceSDK.ENV.Editor](https://reporoster.com/forks/dark/EpicMorg/SourceSDK.ENV.Editor)](https://github.com/EpicMorg/SourceSDK.ENV.Editor/network/members) diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..2509c4b --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,7 @@ +# Security Policy + +## Reporting a Vulnerability +1. Open `Issues` tab [here](https://github.com/EpicMorg/SourceSDK.ENV.Editor/issues). +2. Select `CVE Report`. +3. Publish `CVE Report`. +4. Thank you :heart: