1_new-library.yml

name: 💙 New Library
description: Submit a new Processing library
labels: ["new contribution", "library"]
body:
  - type: markdown
    attributes:
      value: |
        Thank you for your new library contribution to Processing!

        Libraries are add-ons that extend the functionality of the Processing language ([read more](https://github.com/processing/processing4/wiki/Library-Overview)).

        If you need help creating a library, see the [Library Guidelines](https://github.com/processing/processing4/wiki/Library-Guidelines) or ask on the [Processing Forum](https://discourse.processing.org/).

        Please complete the form below with the necessary information about your library.

        ---

        #### About the Properties File

        A properties file (e.g., `myLibrary.txt`) is necessary for submitting your library. It should be a direct copy of your `library.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/myLibrary.txt`
        - `.zip` file: `https://github.com/yourusername/yourrepo/releases/latest/download/myLibrary.zip`

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

        For more details, see the [Release Artifacts section of the Library Guidelines](https://github.com/processing/processing4/wiki/Library-Guidelines#release-artifacts).

        ---
  - type: input
    id: properties_url
    attributes:
      label: Properties File URL
      description: URL of your properties `.txt` file (e.g. `myLibrary.txt`).
      placeholder: https://
    validations:
      required: true
  - type: input
    id: documentation_url
    attributes:
      label: Home Page URL
      description: URL of the home page for your library.
      placeholder: https://
    validations:
      required: true
  - type: input
    id: repository_url
    attributes:
      label: Repository URL
      description: URL of the source code repository for your library.
      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 library's license (e.g., MIT, GPL-3.0-only, LGPL-2.1-or-later). 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 libraries must follow the [Library Guidelines](https://github.com/processing/processing4/wiki/Library-Guidelines).
      options:
        - label: I confirm that my library 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 library 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