search

clessig / atmorep

AtmoRep model code
MIT License
40 stars 9 forks source link

Set up templates for issues #21

Closed clessig closed 2 days ago

clessig commented 3 months ago

Set up templates for bugs and features requests for the AtmoRep git repo. Should we also have templates for scientific features?

iluise commented 1 month ago

something like this?

image

It takes 1 min to set them up:

1) settings 2) scroll down a bit until the section "features" 3) issues: "cluck on "get organised with issues templates" -> set up templates 4) add template -> select

"Bug" and "Features" are automatically generated and we can leave them like this I guess. For the scientific issue, please copy the text below:

Describe the topic A clear and concise description of the scientific topic you want to discuss.

Describe the technical developments A clear and concise description of the technical advancements needed to make this happen. Ideally as bullet points

Additional context Add any other context or screenshots about the discussed topic here.

Related issues link here the issues related to this scientific discussion.

clessig commented 1 month ago

Something like this, doesn't need to be very elaborate but some standard structure is useful (and just as a reminder for what info to include):

Screenshot 2024-09-10 at 08 12 26 Screenshot 2024-09-10 at 08 13 00
iluise commented 1 month ago

Done, please take a look and let me know if we should add other issues or modify something in the existing ones.

clessig commented 1 month ago

I think the list is fine for now. Maybe in the future it would be nice to have one for a downstream application.

There are some "." missing for Bug and Feature, always the last sentence in the line. Can we fix this. And we can close the issue.

iluise commented 2 days ago

done in iluise/head now. closing the issue.