Guidelines on how to make a good feature request

[jonaswinkler]

A title that briefly describes what paperless should do with as few words as possible.

Titles are usually what other users read first when browsing the feature list. Therefore, make sure that they can quickly understand what you're requesting! This will help with both users identifying your request as useful for voting and helps with eliminating duplicates. An example of a good title is:

• "Custom metadata fields on documents"

A not so good title would be:

• "Paperless should let me define custom fields so that I can add invoice numbers to invoices"

Give a short summary of your request.

Describe key features of your proposal. Bullet points are very useful for this.

While doing that, consider other users as well and how/if they would use your feature. A feature request that has use cases for many different scenarios and users is much more likely to get implemented than a feature request for a very specific and niche use case.

Describe your feature in detail.

Describe what you'd like paperless to do in detail. For example, if you'd like to propose adding feature to the UI, present some ideas about where you'd place new buttons and such. If you want to propose changes to the way paperless processes documents, describe how the current process should be altered.

If your request is really small (such as changing the icon of a button), a separate summary and detailed description isn't exactly necessary. For anything bigger, adding some structure to your request increases readability by alot.

Screenshots of UI mockups would be even nicer (paint is totally fine), since its much easier to describe visual things with pictures.