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

Remove code from README #49

Open
raq929 opened this issue Mar 15, 2017 · 3 comments
Open

Remove code from README #49

raq929 opened this issue Mar 15, 2017 · 3 comments

Comments

@raq929
Copy link
Contributor

raq929 commented Mar 15, 2017

All code examples should be in files that are linked to from the README.
@payne-chris-r
Copy link
Contributor

I disagree. This needs to be discussed and we need to make a firm decision on this.

@payne-chris-r
Copy link
Contributor

Per conversations with @gaand and @jrhorn424 we need to leave code in READMEs for now until we figure out a better way to maintain code, but still display it in the README. For now, we leave the READMEs as is, and do our best to make sure that the code we have in there is correct, opening issues and resolving if it is not.

@gaand
Copy link

gaand commented Apr 17, 2017

https://github.com/ga-wdi-boston/node-template/blob/add-code-blocks/bin/add-code-block.js

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@gaand @payne-chris-r @raq929