From d4afcb3542748ac80d64b404d2efdc6df2bb535f Mon Sep 17 00:00:00 2001 From: "Sean P. Myrick V19.1.7.2" Date: Mon, 28 Aug 2023 18:31:45 -0700 Subject: [PATCH] 3 sub-directories [10 files] 3 sub-directories [10 files] --- .github/CODEOWNERS | 194 +++++++++++++++++ .github/ISSUE_TEMPLATE.md | 112 ++++++++++ .github/ISSUE_TEMPLATE/config.yml | 13 ++ .github/ISSUE_TEMPLATE/issue-template.yml | 200 ++++++++++++++++++ .github/ISSUE_TEMPLATE/miscellaneous.yml | 29 +++ .github/PULL_REQUEST_TEMPLATE.md | 55 +++++ .../pull_request_template.md | 101 +++++++++ .../OldVersions/1/1-100/SECURITY_V1.md | 71 +++++++ .github/Security/README.md | 71 +++++++ .github/pull_request_template.md | 101 +++++++++ 10 files changed, 947 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/issue-template.yml create mode 100644 .github/ISSUE_TEMPLATE/miscellaneous.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md create mode 100644 .github/Security/OldVersions/1/1-100/SECURITY_V1.md create mode 100644 .github/Security/README.md create mode 100644 .github/pull_request_template.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..cb88cf5 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,194 @@ +# Start of script +# I am going to keep trying on this until I get it right +# @seanpm2001 is the global code owner for this project +/// @seanpm2001 +// @seanpm2001 +# / @seanpm2001 +/* @seanpm2001 +* @seanpm2001 +# Directories at root +# .github +/.github/ @seanpm2001 +# Docs +/Docs/ @seanpm2001 +# External +/External/ @seanpm2001 +# OldVersions +/OldVersions/ @seanpm2001 +# RepoData +/RepoData/ @seanpm2001 +# Files at root +.editorconfig @seanpm2001 +.gitattributes @seanpm2001 +.gitignore @seanpm2001 +AUTHORS @seanpm2001 +CITATION.cff @seanpm2001 +CONTRIBUTING.md @seanpm2001 +COPYINGL @seanpm2001 +CREDITS @seanpm2001 +DRM-free_label.en.svg @seanpm2001 +INSTALL @seanpm2001 +LINUX_DEFENDER.desktop @seanpm2001 +LICENSE.txt @seanpm2001 +Pax_tux.png @seanpm2001 +PROJECT_LANG_1.py @seanpm2001 +PROJECT_LANG_2.sh @seanpm2001 +README.md @seanpm2001 +SECURITY.md @seanpm2001 +SponsorButton.png @seanpm2001 +desktop.ini @seanpm2001 +makefile.mk @seanpm2001 +# Individual file types +# Section A +*.aiff @seanpm2001 +*.AIFF @seanpm2001 +*.alac @seanpm2001 +*.ALAC @seanpm2001 +*.applescript @seanpm2001 +*.asm @seanpm2001 +*.ASM @seanpm2001 +# Section B +*.bib @seanpm2001 +# Section C +*.c @seanpm2001 +*.C @seanpm2001 +*.cff @seanpm2001 +*.cpp @seanpm2001 +*.css @seanpm2001 +*.cxx @seanpm2001 +# Section D +*.DS_STORE @seanpm2001 +*.desktop @seanpm2001 +*.dmg @seanpm2001 +*.DMG @seanpm2001 +# Section E +*.editorconfig @seanpm2001 +# Section F +# No entries starting with the letter F +# Section G +*.gif @seanpm2001 +*.GIF @seanpm2001 +*.gitattributes @seanpm2001 +*.gitignore @seanpm2001 +*.go @seanpm2001 +# Section H +*.h @seanpm2001 +*.H @seanpm2001 +*.htm @seanpm2001 +*.html @seanpm2001 +# Section I +*.ini @seanpm2001 +*.ipa @seanpm2001 +*.IPA @seanpm2001 +*.iso @seanpm2001 +*.ISO @seanpm2001 +# Section J +*.java @seanpm2001 +*.js @seanpm2001 +*.jpg @seanpm2001 +*.jpeg @seanpm2001 +*.jpp @seanpm2001 +*.json @seanpm2001 +*.jspp @seanpm2001 +# Section K +# No entries starting with the letter K +# Section L +# No entries starting with the letter L +# Section M +*.m @seanpm2001 +*.m4 @seanpm2001 +*.mm @seanpm2001 +*.mak @seanpm2001 +*.make @seanpm2001 +*.markdown @seanpm2001 +*.md @seanpm2001 +*.mdown @seanpm2001 +*.metal @seanpm2001 +*.mhtm @seanpm2001 +*.mhtml @seanpm2001 +*.mp3 @seanpm2001 +*.mk @seanpm2001 +*.mkd @seanpm2001 +*.mot @seanpm2001 +*.MOT @seanpm2001 +*.mov @seanpm2001 +*.MOV @seanpm2001 +# Section N +# No entries starting with the letter N +# Section O +*.oga @seanpm2001 +*.ogg @seanpm2001 +# Section P +*.p @seanpm2001 +*.P @seanpm2001 +*.pas @seanpm2001 +*.PAS @seanpm2001 +*.php @seanpm2001 +*.png @seanpm2001 +*.PNG @seanpm2001 +*.pl @seanpm2001 +*.pro @seanpm2001 +*.ps @seanpm2001 +*.PS @seanpm2001 +*.py @seanpm2001 +# Section Q +*.qs @seanpm2001 +*.qt @seanpm2001 +# Section R +*.rb @seanpm2001 +*.rs @seanpm2001 +# Section S +*.self @seanpm2001 +*.sh @seanpm2001 +*.st @seanpm2001 +*.sql @seanpm2001 +*.svg @seanpm2001 +*.swift @seanpm2001 +# Section T +*.tex @seanpm2001 +*.ts @seanpm2001 +*.tsx @seanpm2001 +*.ttf @seanpm2001 +*.TTF @seanpm2001 +*.txt @seanpm2001 +*.TXT @seanpm2001 +# Section U +*.url @seanpm2001 +*.URL @seanpm2001 +# Section V +*.v @seanpm2001 +*.vh @seanpm2001 +*.vhd @seanpm2001 +*.vhdl @seanpm2001 +*.vtt @seanpm2001 +# Setion W +*.wim @seanpm2001 +*.woff @seanpm2001 +*.WOFF @Seanpm2001 +# Section X +*.xhtm @seanpm2001 +*.xhtml @seanpm2001 +*.xml @seanpm2001 +# Section Y +*.yaml @seanpm2001 +*.yml @seanpm2001 +# Section Z +# No entries starting with the letter Z + +# No more individual file types for now + +# Todo + +# Add every individual file +# Finish adding all file types +# Add new entries as they are added + +# Past goals (completed) +# Add all Wiki entries +# Add all graphics entries + +# File info +# File type: codeowners file (CODEOWNERS) +# File version: 2 (2022, Monday, February 21st at 3:05 pm) +# Line count (including blank lines and compiler line): 195 +# End of script diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..3bd62f3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,112 @@ + +*** + +# Opening an issue in this SNU Programming Tools IDE project + +Thank you for taking the time to open an issue in this SNU web ide project. Please fill out this form to complete the process of opening an issue: + +#### General description + +Please write a description with at least 75 characters in the following space. Limit: 8,196 characters + +``` +Your description goes here +``` + +#### Steps to Reproduce + +Steps should be clear. + +Add steps here + +``` +Your description goes here +``` + +#### Expected Results + + +``` +Your description goes here +``` + +#### Actual Results + + +``` +Your description goes here +``` + +### Browsers Affected + +Please consider opening an issue in [SNU BrowserNose](https://github.com/seanpm2001/SNU_BrowserNose) as well, if BrowserNose fails to do the task. + +Please also specify your virtual machine specs you used for testing if you used a virtual machine, in the space below. Max: 8,196 characters + +Also, please specify the specific browser version down to the last number (example: Firefox 88.0.1esr) and specify if you are running on a desktop or mobile device, and if it (the host system) is virtualized or not + + +- [ ] Tor +- [ ] Mozilla Firefox +- [ ] SeaMonkey +- [ ] Pale Moon +- [ ] TenFourFox +- [ ] Konquerer +- [ ] Line Mode Browser +- [ ] IceWeasel/IceCat +- [ ] IceRaven +- [ ] DuckDuckGo +- [ ] Safari +- [ ] Netscape Navigator +- [ ] Nexus +- [ ] SlimJet +- [ ] AOL Explorer +- [ ] Opera Mini +- [ ] Android stock browser +- [ ] Dot browser +- [ ] Microsoft Edge +- [ ] Opera +- [ ] Samsung Internet +- [ ] Google Chrome +- [ ] Google Chromium +- [ ] Internet Explorer +- [ ] Other + +**Virtual machine config** + +``` +Sample (overwrite this) +Microsoft Windows XP Service Pack 3 +Registry modification for activation +Internet Explorer 6 +VirtualBox 6.1.20 (64 bit) +512 MB RAM +32 Gigabyte disk space +Host operating system: Kubuntu 22.04 +VirtualBox guest additions? Installed +Internet type: Broadband +Specific error: Page won't load, things aren't displaying correctly, see above +``` + +### Versions + +What version are you using? (supported versions only) + +``` +Your description goes here +``` + +- [ ] I have filled out all fields +- [ ] I agree to the terms of the [GPL3 license](https://www.gnu.org/licenses/gpl-3.0.en.html) +- [ ] I have confirmed this issue isn't a duplicate +- [ ] I agree to follow the [code of conduct](https://github.com/seanpm2001/CODE_OF_CONDUCT.md) +- [ ] I want my answer to be archived into the repository + +*** + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..52481b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,13 @@ +blank_issues_enabled: false +contact_links: + - name: I want to help develop + url: https://github.com/seanpm2001/Teams/discussions/ + about: Thank you for your interest in this project! Please consider joining a team to start developing with me + - name: I want to help translate + url: https://github.com/seanpm2001/Teams/discussions/ + about: Thank you for your interest in this project! Please consider joining a team to start translating projects with me + +# File info +# File version: 1 (2022, Thursday, May 19th at 7:07 pm PST) +# File type: GitHub issue template config file (*.yml) +# Line count (including blank lines and compiler line): 14 diff --git a/.github/ISSUE_TEMPLATE/issue-template.yml b/.github/ISSUE_TEMPLATE/issue-template.yml new file mode 100644 index 0000000..8fb2d06 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue-template.yml @@ -0,0 +1,200 @@ +name: General issue +description: Report a bug or other issue/Opening an issue in this SNU Programming Tools IDE project +body: + - type: markdown + attributes: + value: | + Unknown + - type: checkboxes + attributes: + label: Prerequisites + description: | + To rule out invalid issues, confirm and check each one of the checkboxes. + options: + - label: I verified that this is not an existing issue + required: true + - label: This is not a [question, poll, or discussion](https://github.com/seanpm2001/SNU_2D_ProgrammingTools/discussions/) + required: true + - label: I checked the [documentation](https://github.com/seanpm2001/SNU_2D_ProgrammingTools/tree/master/Docs/) to understand that the issue I report is not a normal behavior + required: true + validations: + required: true + + - type: checkboxes + attributes: + label: I tried to reproduce the issue when... + options: + - label: The repository was downloaded to my device/was viewing through the web browser + required: true + - label: I was using the latest version of the project + required: true + - label: I was using the version from the right source + required: false + - label: I did not modify the project + required: false + - type: textarea + attributes: + label: Description + description: Description of the bug or feature. Please also list the version of the programming language you tested with. + validations: + required: true + + - type: textarea + attributes: + label: Steps to Reproduce + placeholder: | + 1. [First Step] + 2. [Second Step] + 3. [and so on...] + validations: + required: true + + - type: textarea + attributes: + label: Expected Results + description: What you expected to happen, example - no error is thrown + placeholder: | + 1. [First Step] + 2. [Second Step] + 3. [and so on...] + validations: + required: true + + - type: textarea + attributes: + label: Actual results + description: What actually happened, error is thrown + validations: + required: true + + - type: input + attributes: + label: Git-image repository version + validations: + required: true + + - type: checkboxes + attributes: + label: Browsers effected, please open an issue in [SNU BrowserNose](https://github.com/seanpm2001/SNU_BrowserNose) as well, if BrowserNose fails to do the task. + options: + label: Tor + required: false + label: Mozilla Firefox + required: false + label: SeaMonkey + required: false + label: Pale Moon + required: false + label: TenFourFox + required: false + label: Konquerer + required: false + label: Line Mode Browser + required: false + label: IceWeasel/IceCat + required: false + label: IceRaven + required: false + label: DuckDuckGo + required: false + label: Safari + required: false + label: Netscape Navigator + required: false + label: Nexus + required: false + label: SlimJet + required: false + label: AOL Explorer + required: false + label: Opera Mini + required: false + label: Android stock browser + required: false + label: Dot browser + required: false + label: Microsoft Edge + required: false + label: Opera + required: false + label: Samsung Internet + required: false + label: Google Chrome + required: false + label: Google Chromium + required: false + label: Internet Explorer + required: false + label: Other + required: false + validations: + required: true + + - type: input + attributes: + label: Specify the specific browser version down to the last number (example Firefox 88.0.1esr) + validations: + required: true + + - type: checkboxes + attributes: + label: I am running this repository in a virtual machine... + options: + - label: Yes (with Oracle VM VirtualBox) + required: false + - label: Yes (with VMWare) + required: false + - label: Yes (with Hyper-V) + required: false + - label: Yes (with Qemu) + required: false + - label: Yes (with another virtual machine option that isn't listed) + required: false + - label: No (I am running it on my host computer) + required: false + + - type: textarea + attributes: + label: Additional virtual machine configuration + placeholder: | + Sample (overwrite this) + Microsoft Windows XP Service Pack 3 + Registry modification for activation + Internet Explorer 6 + VirtualBox 6.1.20 (64 bit) + 512 MB RAM + 32 Gigabyte disk space + Host operating system: Kubuntu 22.04 + VirtualBox guest additions? Installed + Internet type: Broadband + Specific error: Page won't load, things aren't displaying correctly, see above validations: + validations: + required: true + + - type: textarea + attributes: + label: Version used + placeholder: | + What version are you using? (supported versions only) + validations: + required: true + + attributes: + label: Validate issue + options: + - label: I have filled out all the fields + required: true + - label: I agree to the terms of the [GPL3 license](https://www.gnu.org/licenses/gpl-3.0.en.html) + required: true + - label: I have confirmed this issue isn't a duplicate + required: true + - label: I agree to follow the [code of conduct](https://github.com/seanpm2001/CODE_OF_CONDUCT.md) + required: true + - label: I want my answer to be archived into the repository + required: false + +# Issue template info +# 6B (2022, Thursday, May 19th at 6:59 pm PST) +# File type: YAML document (*.yml *.yaml) +# Line count (including blank lines and compiler line): 201 +# File purpose: Serving as a modern issue template for this project. diff --git a/.github/ISSUE_TEMPLATE/miscellaneous.yml b/.github/ISSUE_TEMPLATE/miscellaneous.yml new file mode 100644 index 0000000..5541ab1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/miscellaneous.yml @@ -0,0 +1,29 @@ +name: Miscellaneous +description: Write a general issue without too much questioning +body: + - type: markdown + attributes: + value: | + Unknown + - type: checkboxes + attributes: + label: Prerequisites + description: | + To rule out invalid issues, confirm and check each one of the checkboxes. + options: + - label: I verified that this is not an existing issue + required: true + - label: This is not a question, poll, or discussion + required: true + - label: I checked the documentation to understand that the issue I report is not a normal behavior + required: true + - type: textarea + attributes: + label: Description + description: Your issue description. Make sure to utilize Markdown to make your life easier :) + validations: + required: true +# File info +# File type: GitHub bug report issue template (*.yml) +# File version: 1 (2022, Wednesday, November 23rd at 6:31 pm PST) +# Line count (including blank lines and compiler line): 30 diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..40b92d2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,55 @@ + +*** + +# Opening a pull request on this SNU IDE project + + +Thank you for taking the time to open a PR in this SNU web ide project. Please fill out this form to complete the process of opening an issue: + +#### General description + +Please write a description with at least 75 characters in the following space. Limit: 8,196 characters + +``` +Your description goes here +``` + +#### Reference Issue + + +``` +add the link to the issue to the # below +``` + +#1 // Overwrite this line + +What does your pull request do? + +- [ ] Fixes a bug +- [ ] Adds a feature +- [ ] Fixes a security problem +- [ ] Fixes a typo +- [ ] Adds translation + +### Versions + +What version are you using? (supported versions only) + +``` +Your description goes here +``` + +- [ ] I have filled out all fields +- [ ] I agree to the terms of the [GPL3 license](https://www.gnu.org/licenses/gpl-3.0.en.html) +- [ ] I have confirmed this pull request isn't a duplicate +- [ ] I agree to follow the [code of conduct](https://github.com/seanpm2001/CODE_OF_CONDUCT.md) +- [ ] I want my answer to be archived into the repository + +*** + + diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..6f8bfea --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,101 @@ + +*** + +# Creating a pull request + +Thank you for taking the time to create a pull request in this repository! Please fill out this form before submitting your PR. + +**Note:** you can change the language of the formatting if needed, but it must be valid syntax. Supported languages include: ASCIIDoc, Org mode, Markdown, WikiText, ReStructuredText, Creole, Pod, RDoc, Textile, and plain text. Be sure to change thw `markdown` tag to the appropriate language. + +Provide a general summary of your changes in the Title above + +```markdown +Your summary description (title) goes here +``` + +## Description + +Describe your changes in detail + +```markdown +Your issue description (body) goes here +``` + +## Related Issue + +- [ ] This project only accepts pull requests related to open issues +- [ ] If suggesting a new feature or change, please discuss it in an issue first +- [ ] If fixing a bug, there should be an issue describing it with steps to reproduce +- [ ] Please link to the issue here: + +```markdown +Link to the issue here, #__ +``` + +## Motivation and Context + +Why is this change required? What problem does it solve? + +```markdown + +``` + +## How Has This Been Tested? + +- [ ] Please describe in detail how you tested your changes. +- [ ] Include details of your testing environment, and the tests you ran to. +- [ ] see how your change affects other areas of the code, etc. + +## Screenshots (if appropriate): + +Please include the screenshots inside your pull request as well as a local link (hard copy) + +**Warning:** `.webp` and `.heif` images are not accepted. Please convert them to a different format (such as PNG, JPG, JPEG, JIF, GIF, TIF, etc.) + +**Warning:** Images outside of `/.github/Pull_Requests/Queue/PR/` are not accepted, and will be removed from the PR within 24 hours if not fixed + +```markdown +Remove this section, and only include the links if you use this section. Be sure to delete image fields that are not needed. Max screenshots per PR: 5. Also, if screenshots aren't necessary, please delete this entire section + +![Example1](/.github/Pull_Requests/Queue/PR/Image.png) +![Example2](/.github/Pull_Requests/Queue/PR/Image.png) +![Example3](/.github/Pull_Requests/Queue/PR/Image.png) +![Example4](/.github/Pull_Requests/Queue/PR/Image.png) +![Example5](/.github/Pull_Requests/Queue/PR/Image.png) +``` + +## Types of changes + +What types of changes does your code introduce? Put an `x` in all the boxes that apply: + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Checklist: + +Go over all the following points, and put an `x` in all the boxes that apply. + +If you're unsure about any of these, don't hesitate to ask. We're here to help! + +- [ ] My source code (if source code is provided) follows the source code style of this project. +- [ ] My change requires a change to the documentation. +- [ ] My change does not delete necessary files +- [ ] I have updated the documentation accordingly. +- [ ] I have read the [**`CONTRIBUTING`**](/CONTRIBUTING.md) document in my spoken language, and understand the terms +- [ ] I have added tests to cover my changes. +- [ ] I have gone through all the steps, and have thoroughly read the instructions + +*** + + diff --git a/.github/Security/OldVersions/1/1-100/SECURITY_V1.md b/.github/Security/OldVersions/1/1-100/SECURITY_V1.md new file mode 100644 index 0000000..2cb1d86 --- /dev/null +++ b/.github/Security/OldVersions/1/1-100/SECURITY_V1.md @@ -0,0 +1,71 @@ + +*** + +# Security Policy + +## Supported Versions + +This project is a Git-image project, and doesn't have security issues like common repositories. They are still possible, and instructions will be listed below. + +## Version history + +| Version | Supported | Support status | +| ------- | ------------------ |-----------------| +| Versions | not | listed yet | +| v1.0.0 | :heavy_check_mark: | NOT YET RELEASED | + +## Reporting a Vulnerability + +DO NOT REPORT A ZERO DAY VULNERABILITY PUBLICLY! + +Please instead direct message me via GitHub. If there is no response within 90 days, you can post the vulnerability as an issue, as part of the standard 0 day security exploit reporting guidelines. + +If a vulnerability is caused by an outdated dependancy, you can report it publicly, as it usually isn't that much of a problem. + +Other security currently isn't available. If there are any further questions, message me via email at [seanpm2001-mailing-list@protonmail.com](mailto:seanpm2001-mailing-list@protonmail.com) + +*** + +## File info + +**File type:** `Markdown document (*.md *.mkd *.mdown *.markdown)` + +**File version:** `1 (2022, Thursday, May 19th at 3:05 pm PST)` + +**Line count (including blank lines and compiler line):** `72` + +*** + +## File history + +

Click/tap here to expand/collapse the history for this file

 + +**Version 1 (2022, Thursday, May 19th at 3:05 pm PST)** + +> Changes: + +> * Started the file + +> * Added the supported versions section + +> * Added the version history section + +> * Added the reporting a vulnerability section + +> * Added the file info section + +> * Added the file history section + +> * No other changes in version 1 + +**Version 2 (Coming soon)** + +> Changes: + +> * Coming soon + +> * No other changes in version 2 + +
+ +*** diff --git a/.github/Security/README.md b/.github/Security/README.md new file mode 100644 index 0000000..2cb1d86 --- /dev/null +++ b/.github/Security/README.md @@ -0,0 +1,71 @@ + +*** + +# Security Policy + +## Supported Versions + +This project is a Git-image project, and doesn't have security issues like common repositories. They are still possible, and instructions will be listed below. + +## Version history + +| Version | Supported | Support status | +| ------- | ------------------ |-----------------| +| Versions | not | listed yet | +| v1.0.0 | :heavy_check_mark: | NOT YET RELEASED | + +## Reporting a Vulnerability + +DO NOT REPORT A ZERO DAY VULNERABILITY PUBLICLY! + +Please instead direct message me via GitHub. If there is no response within 90 days, you can post the vulnerability as an issue, as part of the standard 0 day security exploit reporting guidelines. + +If a vulnerability is caused by an outdated dependancy, you can report it publicly, as it usually isn't that much of a problem. + +Other security currently isn't available. If there are any further questions, message me via email at [seanpm2001-mailing-list@protonmail.com](mailto:seanpm2001-mailing-list@protonmail.com) + +*** + +## File info + +**File type:** `Markdown document (*.md *.mkd *.mdown *.markdown)` + +**File version:** `1 (2022, Thursday, May 19th at 3:05 pm PST)` + +**Line count (including blank lines and compiler line):** `72` + +*** + +## File history + +

Click/tap here to expand/collapse the history for this file

 + +**Version 1 (2022, Thursday, May 19th at 3:05 pm PST)** + +> Changes: + +> * Started the file + +> * Added the supported versions section + +> * Added the version history section + +> * Added the reporting a vulnerability section + +> * Added the file info section + +> * Added the file history section + +> * No other changes in version 1 + +**Version 2 (Coming soon)** + +> Changes: + +> * Coming soon + +> * No other changes in version 2 + +
+ +*** diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..6f8bfea --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,101 @@ + +*** + +# Creating a pull request + +Thank you for taking the time to create a pull request in this repository! Please fill out this form before submitting your PR. + +**Note:** you can change the language of the formatting if needed, but it must be valid syntax. Supported languages include: ASCIIDoc, Org mode, Markdown, WikiText, ReStructuredText, Creole, Pod, RDoc, Textile, and plain text. Be sure to change thw `markdown` tag to the appropriate language. + +Provide a general summary of your changes in the Title above + +```markdown +Your summary description (title) goes here +``` + +## Description + +Describe your changes in detail + +```markdown +Your issue description (body) goes here +``` + +## Related Issue + +- [ ] This project only accepts pull requests related to open issues +- [ ] If suggesting a new feature or change, please discuss it in an issue first +- [ ] If fixing a bug, there should be an issue describing it with steps to reproduce +- [ ] Please link to the issue here: + +```markdown +Link to the issue here, #__ +``` + +## Motivation and Context + +Why is this change required? What problem does it solve? + +```markdown + +``` + +## How Has This Been Tested? + +- [ ] Please describe in detail how you tested your changes. +- [ ] Include details of your testing environment, and the tests you ran to. +- [ ] see how your change affects other areas of the code, etc. + +## Screenshots (if appropriate): + +Please include the screenshots inside your pull request as well as a local link (hard copy) + +**Warning:** `.webp` and `.heif` images are not accepted. Please convert them to a different format (such as PNG, JPG, JPEG, JIF, GIF, TIF, etc.) + +**Warning:** Images outside of `/.github/Pull_Requests/Queue/PR/` are not accepted, and will be removed from the PR within 24 hours if not fixed + +```markdown +Remove this section, and only include the links if you use this section. Be sure to delete image fields that are not needed. Max screenshots per PR: 5. Also, if screenshots aren't necessary, please delete this entire section + +![Example1](/.github/Pull_Requests/Queue/PR/Image.png) +![Example2](/.github/Pull_Requests/Queue/PR/Image.png) +![Example3](/.github/Pull_Requests/Queue/PR/Image.png) +![Example4](/.github/Pull_Requests/Queue/PR/Image.png) +![Example5](/.github/Pull_Requests/Queue/PR/Image.png) +``` + +## Types of changes + +What types of changes does your code introduce? Put an `x` in all the boxes that apply: + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Checklist: + +Go over all the following points, and put an `x` in all the boxes that apply. + +If you're unsure about any of these, don't hesitate to ask. We're here to help! + +- [ ] My source code (if source code is provided) follows the source code style of this project. +- [ ] My change requires a change to the documentation. +- [ ] My change does not delete necessary files +- [ ] I have updated the documentation accordingly. +- [ ] I have read the [**`CONTRIBUTING`**](/CONTRIBUTING.md) document in my spoken language, and understand the terms +- [ ] I have added tests to cover my changes. +- [ ] I have gone through all the steps, and have thoroughly read the instructions + +*** + +