The npm community forum has been discontinued.
To discuss usage of npm, visit the GitHub Support Community.
Suggestion: add contributing instructions
zkat suggested submitting a PR for npm but wait, how? There are no instructions in CONTRIBUTING.md for how to work on npm.
So I guessed…
- Fork the repo
- Examine the error message.
npm install --global rimraf
- Wait a long time for stuff to start happening
- Wait a long time for tests to run
- Notice that lots of the tests are failing (the first failing test soon scrolled its way out of the terminal buffer, but eventually I Ctrl+C restarted the tests and noticed that the first failing test was “not ok git started up successfully”. But
gitis installed and is in my PATH.)
At this point I wonder,
- What did I do wrong?
- If I make a change, how do I check if it was correct? Do I have to make a new test for the change? If so, how?
- Since the tests take a long time to execute, how do I set up a fast edit-test cycle for the one tiny thing I’m working on?
As I post this, the tests are still going like Energizer bunny… edit results:
4638 passing (30m) 19 pending 57 failing
This sounds like a great idea to document!
We’ll of course want full docs for different kinds of contributors, but the high-level version looks something like this:
$ git clone firstname.lastname@example.org:<you>/npm.git && cd npm
$ npm install
$ make link
- Write your patch
npm t// This will take a LONG time. Around 5-10 minutes. It’s a big and old test suite that’s gonna take a lot of work to speed up.
- Push to your clone and make a PR. Wait an hour or two for CI to run on all the CI platorms.
If the above doesn’t work as-is, then I consider those bugs in our onboarding process and I would love to have them addressed individually.