Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update issue templates #9

Merged
merged 3 commits into from
Dec 4, 2019
Merged

Update issue templates #9

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c12fc49
Update issue templates
speth Dec 3, 2019
832e94f
Simplify feature request template
speth Dec 4, 2019
0ffb1b9
Explain what this repository is all about
speth Dec 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Feature request
about: " Suggest a new feature to enhance Cantera"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leading space here, and does it need the quotes?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed the leading space. I'm leaving the quotes because GitHub put them there when I used their tool to create these issue templates.

title: ''
labels: feature-request
assignees: ''

---

**Abstract**

A brief description of the proposed change.

**Motivation**

Describe the need for the proposed change:

* What problem is it trying to solve?
* Who is affected by the change?
* Why is this a good solution?

**Description**
Copy link
Member

@decaluwe decaluwe Dec 4, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One thought that comes to mind: this template seems to assume that the requestor has a solution in mind. There should either be a separate template for somebody opening a request but w/ no idea how to solve it, or a hearty dose of "(if applicable)" in this template.

Looking at the work-in-progress template, I think it might be best to leave that as is, and then maybe collapse Description and Alternatives into a single section, here. Something like Possible Solutions?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good point -- a feature request doesn't need that much detail on the implementation, at least to start. Updated accordingly.


A detailed description of the proposed change. This may include examples of how the new feature would be used, intended use cases, and pseudo-code illustrating its use.

**Alternatives**

If any alternative solutions to solving the same problem have been considered, describe them here, along with a justification for the chosen approach.

**References**

Links to related Pull Requests, GitHub Issues, Users' Group topics, or other relevant material.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/work-in-progress.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Work in progress
about: Describe a new feature that you are currently working on
title: ''
labels: work-in-progress
assignees: ''

---

**Abstract**

A brief description of the work being done.

**Motivation**

Describe the need for the work being done:

* What problem is it trying to solve?
* Who is affected by the change?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would an entry for "Files impacted" be worthwhile?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could ask for files / classes impacted, but that feels like more detail than necessary. Once people have modifications underway, I'd like them to link to the in-progress branch where they're working.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, good point. My only thought here was that it would give a way to communicate to others if the "ground beneath their feet" was about to change. i.e. if there is some major change that is going to affect files where they are currently working on changes. But agree that it might be a bit much to ask for...

* Why is this a good solution?

**Description**

A detailed description of the work being done. This may include examples of how the new feature will be used, intended use cases, and pseudo-code illustrating its use.

**Alternatives**

If any alternative solutions to solving the same problem have been considered, describe them here, and explain why the chosen approach is preferred.

**References**

Links to a development branch in your fork of the Cantera repository, Pull Requests, GitHub Issues, Users' Group topics, or other relevant material.