Initial commit

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,70 @@
+# 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, 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 {{ email }}. 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](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html) Code of Conduct.

.github/CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# How to contribute to this module
+
+> Please note: As a loose rule any pull requests for general code cleanup will generally be merged when a new version is released. I have a limited number of hours per week to review and test pull requests. I will do my best to test pull requests within a reasonable time frame, but no guarantees can be made.
+
+## **Did you find a bug?**
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/Celerium/PokeAPI/issues).
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/Celerium/PokeAPI/issues/new/choose).
+  * Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+## **Did you write a patch that fixes a bug?**
+
+* [ ] Submit a pull request to the **dev** branch
+* [ ] Ensure the pull request description clearly describes the problem and solution.
+
+If the feature is accepted and I have time to test, the pull request will be approved.
+
+## **Do you intend to add a new feature or change an existing one?**
+
+* Suggest your change by creating a GitHub issue tagged with "Enhancement"
+
+* Create a branch and start working on your new feature, following feedback from the community.
+
+* Once the new feature is ready,
+
+  * [ ] Update any documentation if needed
+  * [ ] Submit a pulling request to the **development** branch
+
+If the feature is accepted and I have time to test, the pull request will be approved.
+
+Thanks! :heart:
+
+---
+
+> Based off of the Ruby on Rails project [contribution guide](https://github.com/rails/rails/blob/master/CONTRIBUTING.md).

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+custom: 'https://www.buymeacoffee.com/Celerium'

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,88 @@
+name: 🐛 Bug Report
+description: File a bug report to help us improve
+title: "[Bug]: "
+labels: ["type: bug"]
+assignees:
+  - Celerium
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to fill out this bug report!
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      placeholder: Tell us what you see!
+      value: "A bug happened!"
+    validations:
+      required: true
+  - type: textarea
+    id: ExpectedBehavior
+    attributes:
+      label: Expected behavior?
+      placeholder: Tell us what you see!
+      value: "A bug shouldn't have happened!"
+    validations:
+      required: true
+  - type: textarea
+    id: PossibleSolution
+    attributes:
+      label: Possible Solution?
+    validations:
+      required: false
+  - type: dropdown
+    id: PowerShellVersion
+    attributes:
+      label: PowerShell Version
+      description: What version of PowerShell are you running?
+      options:
+        - 5.1 - (PowerShell)
+        - 7.2.x - (PowerShell Core)
+        - 7.3.x - (PowerShell Core)
+        - 7.4.x - (PowerShell Core)
+  - type: dropdown
+    id: OperatingSystem
+    attributes:
+      label: What operating system are you seeing the problem on?
+      multiple: true
+      options:
+        - Windows
+        - Linux - Ubuntu\Debian
+        - Linux - CentOS\RedHat\Fedora
+        - Linux - openSUSE
+        - macOS
+  - 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: PowerShell
+  - type: textarea
+    id: HelpCommands
+    attributes:
+      label: Help Commands
+      description: Please share additional details about your environment.
+      value: "$PSversionTable
+
+        Get-Package -Name xxxModuleNamexxx | Select-Object Name,Version,Source,ProviderName
+
+        Get-ComputerInfo -Property @(
+        'OsName',
+        'OsVersion',
+        'OsOperatingSystemSKU',
+        'OSArchitecture',
+        'WindowsVersion',
+        'WindowsBuildLabEx',
+        'OsLanguage',
+        'OsMuiLanguages'
+        )"
+      render: PowerShell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Celerium/PokeAPI/blob/main/.github/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Project Documentation
+    url: https://celerium.github.io/PokeAPI/
+    about: Read through the generated documentation
+  - name: Vendor Documentation
+    url: https://github.com/Celerium
+    about: Read through the vendors documentation
+  - name: Celerium.org
+    url: https://celerium.org
+    about: Website were I publish more information related to this project.

.github/ISSUE_TEMPLATE/documentation_request.yml

@@ -0,0 +1,40 @@
+name: 📝 Documentation Request
+description: Suggest extra documentation for this project
+title: "[Documentation Request]: "
+labels: ["type: documentation"]
+assignees:
+  - Celerium
+body:
+  - type: checkboxes
+    id: ReadME
+    attributes:
+      label: Project README
+      description: "[Project README](https://github.com/Celerium/xxxREPONAMExxx/blob/main/README.md)"
+      options:
+        - label: "Have you read the projects README?"
+  - type: checkboxes
+    id: WebDocumentation
+    attributes:
+      label: Online Documentation
+      description: "[Online Documentation](https://Celerium.github.io/xxxREPONAMExxx/)"
+      options:
+        - label: "Have you read the online documentation"
+  - type: checkboxes
+    id: PowerShellHelp
+    attributes:
+      label: PowerShell Help
+      description: "Get-Help Get-xxxModulePrefixxxx<RESOURCES-NAME> -Full"
+      options:
+        - label: "Have you read the help output?"
+  - type: textarea
+    id: DocumentationRequest
+    attributes:
+      label: Documentation Request
+      description: What would you like to see more documentation around?
+      render: Text
+  - type: textarea
+    id: ExistingIssue
+    attributes:
+      label: Existing Issue?
+      description: Is this related to an existing issue? If so please describe or link.
+      value: "Issue: #12345"

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,46 @@
+name: 🚀 Feature Request
+description: Suggest a new feature for this project
+title: "[Feature Request]: "
+labels: ["type: feature request"]
+assignees:
+  - Celerium
+body:
+  - type: checkboxes
+    id: ReadME
+    attributes:
+      label: Project README
+      description: "[Project README](https://github.com/Celerium/xxxREPONAMExxx/blob/main/README.md)"
+      options:
+        - label: "Have you read the projects README?"
+  - type: checkboxes
+    id: WebDocumentation
+    attributes:
+      label: Online Documentation
+      description: "[Online Documentation](https://Celerium.github.io/xxxREPONAMExxx/)"
+      options:
+        - label: "Have you read the online documentation"
+  - type: checkboxes
+    id: PowerShellHelp
+    attributes:
+      label: PowerShell Help
+      description: "Get-Help Get-xxxModulePrefixxxx<RESOURCES-NAME> -Full"
+      options:
+        - label: "Have you read the help output?"
+  - type: textarea
+    id: NewFeature
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+      render: Text
+  - type: textarea
+    id: NewFeatureAlternatives
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+      render: Text
+  - type: textarea
+    id: ExistingIssue
+    attributes:
+      label: Existing Issue?
+      description: Is this related to an existing issue? If so please describe or link.
+      value: "Issue: #12345"

.github/ISSUE_TEMPLATE/help_request.yml

@@ -0,0 +1,40 @@
+name: 👋 Help Request
+description: What can the community help with
+title: "[Help Request]: "
+labels: ["help wanted"]
+assignees:
+  - Celerium
+body:
+  - type: checkboxes
+    id: ReadME
+    attributes:
+      label: Project README
+      description: "[Project README](https://github.com/Celerium/xxxREPONAMExxx/blob/main/README.md)"
+      options:
+        - label: "Have you read the projects README?"
+  - type: checkboxes
+    id: WebDocumentation
+    attributes:
+      label: Online Documentation
+      description: "[Online Documentation](https://Celerium.github.io/xxxREPONAMExxx/)"
+      options:
+        - label: "Have you read the online documentation"
+  - type: checkboxes
+    id: PowerShellHelp
+    attributes:
+      label: PowerShell Help
+      description: "Get-Help Get-xxxModulePrefixxxx<RESOURCES-NAME> -Full"
+      options:
+        - label: "Have you read the help output?"
+  - type: textarea
+    id: HelpRequest
+    attributes:
+      label: Help Request
+      description: What would you like help with?
+      render: Text
+  - type: textarea
+    id: ExistingIssue
+    attributes:
+      label: Existing Issue?
+      description: Is this related to an existing issue? If so please describe or link.
+      value: "Issue: #12345"

.github/SECURITY.md

@@ -0,0 +1,32 @@
+# Responsible Security Disclosure README standard
+
+## Our security policy and Your responsibility
+
+- **POLICY**:
+
+*Our security policy is to avoid leaving the ecosystem worse than we found it. Meaning we are not planning to introduce vulnerabilities into the ecosystem.*
+
+The "PokeAPI" team and community take all security bugs in "PokeAPI" seriously. Thank you for improving the security of "PokeAPI". We appreciate your efforts and responsible disclosure and will make every effort to acknowledge your contributions.
+
+Report security bugs by emailing the lead maintainer at [celerium@celerium.org] and include the word "SECURITY" in the subject line..
+
+The lead maintainer will acknowledge your email within a week, and will send a more detailed response 48 hours after that indicating the next steps in handling your report. After the initial reply to your report, the security team will endeavor to keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.
+
+- "PokeAPI" will confirm the problem and determine the affected versions.
+- "PokeAPI" will audit code to find any potential similar problems.
+- "PokeAPI" will prepare fixes for all releases still under maintenance. These fixes will be released as fast as possible.
+
+Report security bugs in third-party modules to the person or team maintaining the module.
+
+- **SECURITY DISCLOSURE**:
+
+*Your responsibility is to report vulnerabilities to us using the guidelines outlined below.*
+
+Discuss how someone should disclose a vulnerability to "PokeAPI", in tl;dr ( or ELI5 ) language. Then expand on this with "How To Disclose a vulnerability in detail". Please give detailed steps on how to disclose the vulnerability. Keep these OWASP guidelines in mind ( <https://www.owasp.org/index.php/Vulnerability_Disclosure_Cheat_Sheet> ) when creating your disclosure policy. Below are some recommendations for security disclosures:
+
+- "PokeAPI" security contact { contact: mailto:[celerium@celerium.org] }
+- Disclosure format: When disclosing vulnerabilities please
+  1. Your name and affiliation (if any).
+  2. include scope of vulnerability. Let us know who could use this exploit.
+  3. document steps to identify the vulnerability. It is important that we can reproduce your findings.
+  4. how to exploit vulnerability, give us an attack scenario.