Skip to content

Example readme - #11

Merged
cmonagle merged 2 commits into
masterfrom
cm/example-readme
May 13, 2020
Merged

Example readme#11
cmonagle merged 2 commits into
masterfrom
cm/example-readme

Conversation

@cmonagle

@cmonagle cmonagle commented May 12, 2020

Copy link
Copy Markdown
Contributor

closes #7

@cmonagle
cmonagle requested review from juanborre and rsecob May 12, 2020 21:47
@cmonagle cmonagle self-assigned this May 12, 2020

@juanborre juanborre left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. Just one comment


Describe the development environment. Include basic instructions--does this repository prefer `npm ci` or `npm i`? Does prettier run on save? Any special settings or extensions you should set up in your IDE?

If you're not sure where to start, consider explaining the npm scripts that might be relevent for getting a development environment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably here we should add the environment variables needed to run it or to modify its behaviour.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call, thank you!

@cmonagle
cmonagle merged commit 00e12a4 into master May 13, 2020

@rsecob rsecob left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great initiative, thank you for doing this!

@cmonagle
cmonagle deleted the cm/example-readme branch May 13, 2020 14:39
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

Successfully merging this pull request may close these issues.

Example readme

3 participants