creativecommons / creativecommons.github.io-source

Source files for CC Open Source website
https://opensource.creativecommons.org/
MIT License
79 stars 175 forks source link

[Content] The need to require a Node.js version is not specified in JavaScript Guidelines #666

Open possumbilities opened 2 years ago

possumbilities commented 2 years ago

Problem

Currently there is not a consistent method across repositories for requiring a minimum Node.js version. This can and will create issues for contributing to repositories.

Description

This can be solved by adding guidance in the Javascript Guidelines to add:

"engines" : { "npm" : ">=x.y.z","node" : ">=x.yz"} to the package.json file as a baseline standard

Alternatives

Additionally, you can edit the .npmrc file to contain:

# .npmrc
engine-strict=true

but this provides inconsistent behavior, as local devs may have their own pre-existing .npmrc file.

A .nvmrc route is also possible and might have better outcomes

Additional context

Implementation

Inzamamdev commented 1 year ago

So just have to include the instruction @possumbilities

osujipius commented 2 months ago

@TimidRobot Can I work on this?

TimidRobot commented 2 months ago

Please see Contribution Guidelines — Creative Commons Open Source for how we manage issues and PRs.

We generally don't assign issues prior to resolution. Instead of asking for issues to be assigned, do the work and submit a pull request (PR). Even if multiple people submit PRs for the same issue, multiple ideas and implementations strengthen the final product.

For work program applicants, each can all list their own PRs on their application. It is the quality of work that is important, not whether it is merged.

Srayash commented 1 month ago

@possumbilities does this issue require changing package.json in all the directories?