-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Initial YAML issue template for adding new database entry for a sensor #33
Conversation
A more user-friendly form-based way of contributing to the Polar EO Database! Users can open an issue and select dropdowns to fill up the template. See also https://github.blog/changelog/2021-06-23-issues-forms-beta-for-public-repositories and https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.
Awesome, thanks a lot for working on this! So if I understand correctly, this is a GUI that's filling in a YAML? And this is through an issue, but how is it linked to a potential PR then? Is that the part that we still have to develop? A bot that would create a PR based on a template-generated issue? |
Yes, it's essentially just a structured form. This is actually designed for filling up bug reports/feature requests so the output isn't actually a YAML but there will be a GitHub issue opened as a result. From that issue, we will then need to parse the outputs (which is already structured) into a proper Pull Request.
Yep, so there are a few ways/steps to link an issue to a PR, which can be automated by a bot. Just some ideas:
Either way, we could pretty much just guide the user on what to do next, e.g. provide a link to https://github.com/APECS-Earth-Observation/Polar-EO-Database/new/main/data, maybe pre-fill all the data they've already filled in from the YAML, and then it's close enough to a PR, What do you think? |
Super nice, I love it! Having a welcome bot sounds like a good idea and fun to setup! Since, as you say it, this is already structure, it shouldn't be too hard! :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Super nice, thanks a lot for working on this!
A more user-friendly form-based way of contributing to the Polar EO Database! Users can open an issue and select dropdowns to fill up the template.
Preview at https://github.com/APECS-Earth-Observation/Polar-EO-Database/blob/issue-yaml-form/.github/ISSUE_TEMPLATE/new_database_entry.yml
References: