Explicitly document supported Node & Python versions per major release in README
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10.7k
- Forks
- 1.9k
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 5
Description
Many users encounter confusing errors because they are using older versions of node-gyp being required by other dependencies. However, some developers, including myself, are hesitant to explicitly resolve to a higher version of node-gyp as it may introduce new compatibility issues, e.g. older versions of Node or Python being dropped.
Can the supported Python & Node versions per major release be explicitly documented in the README? For example, one row may look like:
| node-gyp version | Compatible Python versions | Compatible Node versions |
|---|---|---|
| ^9.0.0 | >=3.7,<=3.10 | >=12,<=18 |
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the README and the compatibility concerns described in the issue. Determine the supported Python and Node versions for each major node-gyp release, then document them in a clear table; done means users can identify compatible versions without relying on external reports.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nodejs, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100