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

Better visibility of what forkability looks for _before_ being run #71

Open
dougaitken opened this issue Dec 12, 2015 · 3 comments
Open

Comments

@dougaitken
Copy link

After a glance over of the readme and the webapp, I couldn't tell what forkability looked for before running the app. I know it shows a demo output under Node Module / Command Line, but can I open a PR to have this show more prominently in the README / index page of the webapp?

# Forkability found 6 recommended features, and has 2 suggestions

# Features (6)
✓ Contributing document
✓ Readme document
✓ License document
✓ .gitignore file
✓ Test suite
✓ Tags are being used

---

# Suggestions (2)
! Changelog document
! Uncommented issue: Comment on the issue to indicate acknowledgement
└── Media Responses: https://github.com/basicallydan/interfake/issues/19
@M-Zuber
Copy link
Collaborator

M-Zuber commented Dec 12, 2015

Good catch.
Thank you, and please do open a PR

@basicallydan
Copy link
Owner

Hi @dougaitken thanks for the issue!

Sure make a PR. However, for the command line output it's pretty high up in the readme, right under instructions. As for the web app, I don't think that same text is appropriate alongside the main form.

For the web app, I think I'd rather see an actual live example, maybe have a big-ish button which links to the Forkability result for Forkability?

Also, under the heading "Web App" in the README perhaps a screenshot of the output could be shown to give people an idea? What do you guys think?

@M-Zuber
Copy link
Collaborator

M-Zuber commented Dec 13, 2015

a screenshot with a button that links to forkability for forkabilty sounds good to me

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

No branches or pull requests

3 participants