Create a Template for People to Submitt Community Submission requests

[anajsana]

Idea to create a GitHub issue template that allows folks to easily submit their community details using a clear and structured format. This will help collect consistent information about different community groups that want to be listed. We can also make use of GitHub actions to trigger an automated message when an issue is created to mention that the group will review and get back to them when ready (depending on the review / selection process)

Steps

1. Create a new issue template file in https://github.com/chaoss/oscdb/.github/ISSUE_TEMPLATE/community-submission.yml

2. Add the following YAML content to the file:

name: Community Submission
description: Submit your community to be included in our listings or initiatives
title: "[Community Submission] <Community Name>"
labels: ["community", "submission"]
body:
  - type: markdown
    attributes:
      value: |
        🙌 Thank you for submitting your community! Please complete the form below with the required information
  - type: input
    id: community-name
    attributes:
      label: Community Name
      placeholder: e.g Awesome Dev and Country Name
    validations:
      required: true
  - type: textarea
    id: description
    attributes:
      label: Description
      description: Briefly describe the purpose or focus of your community.
      placeholder: e.g A group of developers meeting monthly to discuss cloud-native
    validations:
      required: true
  - type: input
    id: website
    attributes:
      label: Website or Link
    validations:
      required: true
  - type: input
    id: region
    attributes:
      label: Region
      placeholder: e.g China, India, Japan
    validations:
      required: true
  - type: dropdown
    id: category
    attributes:
      label: Community Category
      options:
        - Developer Group
        - Meetup
        - Chapter
        - Other
    validations:
      required: true
  - type: dropdown
    id: format
    attributes:
      label: Format
      options:
        - In-person
        - Virtual
        - Hybrid
    validations:
      required: true

Assignee

Ana (myself) can create a PR if the community likes the idea 🙂

[SammanSarkar]

Sure, maybe we can do this -

• Users add new data by opening a GitHub Issue using a special form that automatically tags it with a “submission” label.
• A GitHub Action watches for these “submission” issues, takes the data from each issue, saves it as its own JSON or CSV file inside a submissions/ folder on a new branch, and creates a pull request.
• Because every submission is saved in a separate file, there are no merge conflicts; after the pull request is merged, another Action combines all these files from submissions/ into one main data.csv file that the website uses.

This avoids CSV conflicts by using separate files. Thoughts? @divya-mohan0209

[divya-mohan0209]

Hi @anajsana - thank you so much for the suggestion! I like the idea of an issue template.

@SammanSarkar I would advise against automating it, simply because, as of now, there are only two of us to verify the PRs/issues being reported. While I'll open an issue and draft a document detailing what could constitute a community that can be listed on the database, it'd be essential to have that guardrail before we automate the issue template. WDYT?

[anajsana]

Thanks for the quick reply! Based on your comments. Here are my thoughts:

1. I could work first by submitting a PR with the template and with a GH simple action that assigns the tag idea suggested by @SammanSarkar and link to this issue

2. Separately, create another issue to explore the full automation structure for the future, once the project matures a bit more

What do you think?

[divya-mohan0209]

SGTM @anajsana ! Thank you so much for helping out 💜

[anajsana]

PR created and waiting for review: #12 🙂

[SammanSarkar]

@divya-mohan0209 Makes sense to delay the automation part for now. What do you think about handling the merging conflict issue by keeping each PR as a separate file and generating the CSV in CI?

[divya-mohan0209]

Sounds okay to me, @SammanSarkar. Could we please open a separate issue to discuss this?