# Information to include in feature requests / feedback

**URL:** <https://forum.getodk.org/t/information-to-include-in-feature-requests-feedback/7096>\
**Category:** Community\
**Tags:** convening-2017\
**Created:** [June 30, 2017, 2:41am UTC](https://forum.getodk.org/t/information-to-include-in-feature-requests-feedback/7096 "2017-06-30T02:41:20Z")\
**Posts on this page:** 6\
**Page:** 1

<div class="post-metadata">

**Author:** ![allieber](https://getodk.b-cdn.net/user_avatar/forum.getodk.org/allieber/32/1813_2.png) [@allieber](https://forum.getodk.org/u/allieber)\
**Post date:** [June 30, 2017, 2:41am UTC](https://forum.getodk.org/t/information-to-include-in-feature-requests-feedback/7096/1 "2017-06-30T02:41:20Z")

</div>

While the general rule of thumb is include as much information as possible, it would be great to put together some example questions and/or template(s) for non-coders to use as guidance when reporting an issue, and/or requesting a feature. We can collect ideas here them post them in the features section. Thoughts?

Here are some ideas....

**Report an issue:**

- Help us pinpoint the issue: Which tool are reporting about? Which build (or version) are you using? Which device are you using?
- Attach a screenshot of the issue (if possible)
- What were you trying to do when the issue arose? What was the goal of the action that led to the issue?
- Describe the issue.
- Include steps for someone to try to recreate the issue.

**Request a feature:**

- Which tool is this for? Collect? Aggregate? Build?
- Give a quick summary of the feature being requested.
- Describe this feature to the best of your ability.
- What is the general goal of this feature?
- What are some example use cases for this feature?
- What is the potential impact of the feature?

---

<div class="post-metadata">

**Author:** ![LN](https://getodk.b-cdn.net/user_avatar/forum.getodk.org/ln/32/1605_2.png) [@LN](https://forum.getodk.org/u/LN)\
**Post date:** [June 30, 2017, 5:33am UTC](https://forum.getodk.org/t/information-to-include-in-feature-requests-feedback/7096/2 "2017-06-30T05:33:40Z")

</div>

Thank you, @allieber! This is so important.

I added to the [Support category description](https://forum.getodk.org/t/about-the-support-category/15) based on your suggestions. The [Features category description](https://forum.getodk.org/t/about-the-features-category/6667) didn't have any guiding questions and I added your suggestions with minor tweaks.

If you or anyone else has any suggested wording changes or additions/removals, please suggest!

Does anyone have any recommendations for making these posts more visible? They're pinned at the top of their respective categories but I don't know how obvious it is that they should be read. 🤔

---

<div class="post-metadata">

**Author:** ![downey](https://getodk.b-cdn.net/user_avatar/forum.getodk.org/downey/32/1630_2.png) [@downey](https://forum.getodk.org/u/downey)\
**Post date:** [June 30, 2017, 6:18am UTC](https://forum.getodk.org/t/information-to-include-in-feature-requests-feedback/7096/3 "2017-06-30T06:18:27Z")

</div>

What about using these questions as the [topic template](https://meta.discourse.org/t/topic-templates/18282) for the category via the category settings? That way anyone creating a new topic (feature request) can start with this outline for consistency.

---

<div class="post-metadata">

**Author:** ![yanokwa](https://getodk.b-cdn.net/user_avatar/forum.getodk.org/yanokwa/32/1695_2.png) [@yanokwa](https://forum.getodk.org/u/yanokwa)\
**Post date:** [July 2, 2017, 11:44pm UTC](https://forum.getodk.org/t/information-to-include-in-feature-requests-feedback/7096/4 "2017-07-02T23:44:19Z")

</div>

I like this idea, @downey. How should we handle the case where we move a topic into a feature? Do we just ask the originator to edit the post to answer those questions?

---

<div class="post-metadata">

**Author:** ![downey](https://getodk.b-cdn.net/user_avatar/forum.getodk.org/downey/32/1630_2.png) [@downey](https://forum.getodk.org/u/downey)\
**Post date:** [July 2, 2017, 11:55pm UTC](https://forum.getodk.org/t/information-to-include-in-feature-requests-feedback/7096/5 "2017-07-02T23:55:50Z")

</div>

Yeah, it can really only be enforced socially. But hopefully would get folks in a good habit of answering the "right" questions!

---

<div class="post-metadata">

**Author:** ![yanokwa](https://getodk.b-cdn.net/user_avatar/forum.getodk.org/yanokwa/32/1695_2.png) [@yanokwa](https://forum.getodk.org/u/yanokwa)\
**Post date:** [July 4, 2017, 12:54am UTC](https://forum.getodk.org/t/information-to-include-in-feature-requests-feedback/7096/6 "2017-07-04T00:54:05Z")

</div>

Great ideas all around! I've added topic templates to features and support. Let's give it a few days and see if the quality goes up!
