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

Update and revise contributing guide #158

Merged
merged 5 commits into from
Feb 12, 2022
Merged

Update and revise contributing guide #158

merged 5 commits into from
Feb 12, 2022

Conversation

zekefarwell
Copy link
Collaborator

I updated the contributing guide to better match the state of the project. Removed out of date info, simplified some things, expanded on some other things. Hopefully it's an overall improvement.

Add js folder to description
Tweak language to make OMT basis more generic
Copy link
Member

@ZeLonewolf ZeLonewolf left a comment

Choose a reason for hiding this comment

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

Looks good to me. I made some adjustments. Thanks Zeke for taking this on!

@ZeLonewolf ZeLonewolf merged commit 5a11aa5 into main Feb 12, 2022
@ZeLonewolf ZeLonewolf deleted the docs-revisions branch February 12, 2022 18:12
@adamfranco
Copy link
Collaborator

Sorry for being late to reviewing -- the updated CONTRIBUTING.md says to use npm install, but the dependencies are currently dev-dependencies, which require npm install --include=dev. We could make these normal dependencies if the intention is to not allow usage of Americana code by other projects(see #146), or we should update the docs to add the --include=dev. I could go either way.

@zekefarwell
Copy link
Collaborator Author

zekefarwell commented Feb 12, 2022

In my experience npm install installs both dependencies and devDependencies unless running in a production context. So adding --include=dev shouldn't be necessary when running the project for local development.

From the NPM Docs:

By default, npm install will install all modules listed as dependencies in package.json.

With the --production flag (or when the NODE_ENV environment variable is set to production), npm will not install modules listed in devDependencies. To install all modules listed in both dependencies and devDependencies when NODE_ENV environment variable is set to production, you can use --production=false.

More explanation here

When you (or another user) run npm install, npm will download dependencies and devDependencies that are listed in package.json

I think maybe in older versions of NPM it didn't work this way and you did have to explicitly include devDependencies. I haven't needed to since at least v6, though. Maybe even earlier.

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.

3 participants