4_new-examples.yml

name: 📦 New Example Pack
description: Submit a new Processing example pack
labels: ["new contribution", "examples"]
body:
  - type: markdown
    attributes:
      value: |
        Thank you for your new example pack contribution to Processing!

        An example package is a set of sample Processing sketches bundled together that can be downloaded and installed so the user can access them from the Processing Examples window.

        If you need help creating an example pack, see the [Examples Overview](https://github.com/processing/processing/wiki/Examples-Overview) or ask on the [Processing Forum](https://discourse.processing.org/).

        Please provide the necessary information below.

        ---

        #### About the Properties File

        A properties file (e.g., `myExamples.txt`) is necessary for submitting your example pack. It should be a direct copy of your `examples.properties` file, hosted in the same directory as your `.zip` distribution, and share the same base name.

        **Example:**
        If your release artifacts are hosted at `https://github.com/yourusername/yourrepo/releases/latest/`, ensure these files are available:
        - `.txt` file: `https://github.com/yourusername/yourrepo/releases/latest/download/myExamples.txt`
        - `.zip` file: `https://github.com/yourusername/yourrepo/releases/latest/download/myExamples.zip`

        > [!IMPORTANT]
        > Make sure to keep the same URL in the future. If you release a new version, the URL should remain the same.

        ---
  - type: input
    id: properties_url
    attributes:
      label: Properties File URL
      description: URL of your properties `.txt` file (e.g. `myExamples.txt`).
      placeholder: https://
    validations:
      required: true
  - type: input
    id: documentation_url
    attributes:
      label: Home Page URL
      description: URL of the home page for your example pack.
      placeholder: https://
    validations:
      required: true
  - type: input
    id: repository_url
    attributes:
      label: Repository URL
      description: URL of the source code repository for your example pack.
      placeholder: https://github.com/username/repository
    validations:
      required: false
  - type: input
    id: github_username
    attributes:
      label: GitHub Username
      description: Your GitHub username.
      placeholder: username
    validations:
      required: false
  - type: input
    id: license_spdx
    attributes:
      label: License SPDX Identifier
      description: SPDX identifier for your example pack's license (e.g., MIT, GPL-3.0-only, CC-BY-4.0). See [SPDX License List](https://spdx.org/licenses/) for valid identifiers.
      placeholder: MIT
    validations:
      required: false
  - type: checkboxes
    id: guidelines_confirmation
    attributes:
      label: Guidelines Confirmation
      description: All example packs must follow the guidelines described on the [Examples Overview](https://github.com/processing/processing/wiki/Examples-Overview) page.
      options:
        - label: I confirm that my example pack follows the guidelines.
          required: true
    validations:
      required: true
  - type: markdown
    attributes:
      value: |
        ---

        Once you submit this form, the `.txt` file at the provided URL will be parsed and validated.

        The result of this validation will be added to this issue:
        - If valid, a pull request will automatically be created to add your example pack to the repository.
        - If invalid, a comment will be added with details of the error. You will need to fix the file and resubmit.
        
        ---
  - type: input
    id: remarks
    attributes:
      label: Additional Remarks
      description: Anything else you'd like to mention about your submission - any comments or questions.
      placeholder: Tell us any other information or questions about your submission