Picocrypt/.github/ISSUE_TEMPLATE/default.yml

name: Default template
description: The default template for all issues
body:
  - type: markdown
    attributes:
      value: |
        # Rules
  - type: markdown
    attributes:
      value: |
        **Please read this section carefully and completely. You may be blocked from this repository if you violate the rules.**
  - type: markdown
    attributes:
      value: |
         Picocrypt is a "finished" piece of software and is in a maintenance-only stage. This does not mean the software is old, outdated, or abandonware, but that the focus is on fixing bugs and ensuring the software continues to work smoothly as opposed to actively developing new features. As well, my time as the developer is limited considering that Picocrypt brings me no monetary benefit and is entirely a gift of my time and skill to the community.
  - type: markdown
    attributes:
      value: |
        *To ensure that issues remain relevant and as time-efficient as possible for me, please follow the guidelines below depending on the type/topic of your issue.*
  - type: markdown
    attributes:
      value: |
        ### Bug reports or security issues
  - type: markdown
    attributes:
      value: |
        These are high-priority issues and the main purpose of this repository's issue tracker. Make the issue with a short description, and then once the issue is created, add a comment with as many details as possible. Ping me (@HACKERALERT) in the comment so that I can get to it as soon as possible. Keep in mind that I define "bug" as something wrong with Picocrypt's code itself. If it's not Picocrypt's fault, it's not a bug.
  - type: markdown
    attributes:
      value: |
        ### Problems running/starting Picocrypt
  - type: markdown
    attributes:
      value: |
        Usually these issues are not directly caused by Picocrypt's code. Create the issue and in a separate comment, provide details about the environment you're running in (like OS, DE, etc.). **Do not ping me initially.** Let the issue sit for at least *3 days* to allow other users to potentially help you resolve the issue. If after 3 days, you haven't figured things out, then you may ping me (@HACKERALERT).
  - type: markdown
    attributes:
      value: |
        ### Antivirus problems
  - type: markdown
    attributes:
      value: |
        These are unpreventable; Picocrypt is cryptography, file deletion, and passwords bundled into an executable... which looks similar to ransomware, unfortunately. Please report these false positives to your antivirus software provider and do not create an issue about it.
  - type: markdown
    attributes:
      value: |
        ### Support requests/usage questions
  - type: markdown
    attributes:
      value: |
        Create the issue and ask your question or support request in a separate comment. **Do not ping me initially.** Let the issue sit for at least *5 days* to give other users a chance to help you first. If after 5 days, you have not received any assistance, then you may ping me (@HACKERALERT).
  - type: markdown
    attributes:
      value: |
        ### Feature requests/suggestions
  - type: markdown
    attributes:
      value: |
        Picocrypt is mature software; I do not intend to add any new features. Generally, do not create any feature requests unless it's very minor and can be implemented with low effort and minimal impact on reliability and security. What is considered "minor" is subjective, but here is an example: "the ability to decrypt a volume entirely in-memory" is pretty significant, while "auto start encryption on pressing the Enter key" is relatively minor. A proof-of-concept link to code or a fork would be appreciated.
  - type: markdown
    attributes:
      value: |
        ### Performance issues/improvements
  - type: markdown
    attributes:
      value: |
        Picocrypt prioritizes correctness and reliability over performance, so many parts of the code are written sequentially and don't use concurrency. This is intentional and need not be pointed out. Unless performance is absolutely atrocious to the point where it is indicative of a potential bug, do not make issues about performance.
  - type: markdown
    attributes:
      value: |
        ### Other issues/generic topics
  - type: markdown
    attributes:
      value: |
        You will have to use your best judgement here. Read the sections above to get an idea of what I expect to see and do what you think is best. Ideally, ping me only if sufficient time has passed for other users to assist/answer you, or it is best addressed by me directly.
  - type: checkboxes
    attributes:
      label: "Please confirm:"
      options:
        - label: "I have carefully read and agree to the rules outlined above"
          required: true
        - label: "I will provide as many helpful details as possible"
          required: true
        - label: "I acknowledge my issue may be ignored or closed without explanation"
          required: true
  - type: input
    attributes:
      label: "Describe the issue briefly in a few sentences:"
      description: "You can add more details in a separate comment after creating the issue."
    validations:
      required: true