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.

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

Provide a brief description of what each app idea is/does #11

Open
dashed opened this issue Jan 17, 2016 · 7 comments
Open

Provide a brief description of what each app idea is/does #11

dashed opened this issue Jan 17, 2016 · 7 comments

Comments

@dashed
Copy link

dashed commented Jan 17, 2016

I think it's useful if there's a brief description of what each app is/does.

Example: This doesn't seem 'obvious' to me: BTN workouts app

@sindresorhus
Copy link
Member

Agreed. I was thinking the same the other day too.

I've added contributing guidelines which requires this, but someone will still need to add it to existing suggestions. Help welcome :)

@addyosmani
Copy link
Member

Agreed. I wasn't a fan of how we approached this before (each app idea being on the same line) as it makes it difficult to quickly browse. Does anyone have thoughts on how best to format/present the description?

Maybe we have a TOC/Index at the top of the file then just link down to the heading with a description. Best of both worlds?

This was referenced Jan 18, 2016
@ijc-90
Copy link

ijc-90 commented Jan 18, 2016

Totally agree. It could be on other file to keep it clean

@sindresorhus
Copy link
Member

I would go with the formatting:

## Table of Contents

- [Category unicorn](#category-unicorn)


## Category unicorn

### App idea

Description.

### Another glorious idea

Description.

@passy
Copy link
Member

passy commented Jan 18, 2016

👍 to @sindresorhus' structure. Let's not impose too many details onto people just yet, but a description in a few sentences would definitely help. If there's no elevator-pitch version for it, it's probably not within the scope of this anyway.

@passy passy mentioned this issue Jan 19, 2016
@denar90
Copy link

denar90 commented Jan 23, 2016

What if make some script to check formatting and then let CI check if changes in pull request is valid?

@YerkoPalma
Copy link

Maybe the new github template for PR could help here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants