Open Requirements

[Rodrigo Silveira]

Hi - I would love to contribute, but I'm shy of doing so without more details as to the requirements. Let me know if you want to chat about it.

Regards
Rodrigo

[Abraham Williams]

There are no specific requirements to contributing to Nutmeg. The generally approach should look like this:

1. Identify something to add or improve
2. Open a new issue to explain the change and why it should be made
3. Discuss or get 👍 from a team member
4. Start implementing or ask for guidance if it's unfamiliar territory.

Please let me know if you have any additional questions.

[Rodrigo Silveira]

I do have a REALLY dumb question ... how does the nutmeg-cli build process builds the bin folder?

[Abraham Williams]

the bin folder is static and doesn't change. It is part of the NPM API for building CLIs.

This following snippet tells NPM to register nutmeg and nutmeg-new as programs the user can interact with. nutmeg-new is supposed to be called directly, instead nutmeg will forward commands with new to it transparently.

package.json file:

{
  "bin": {
    "nutmeg": "bin/nutmeg",
    "nutmeg-new": "bin/nutmeg-new"
  },
}

Than Node takes over and handles executing the code described in nutmeg-new. This file just loads whatever is in the dist/new.js file and executes it.

nutmeg-new file:

#!/usr/bin/env node

require('../dist/new');

Files in the dist directory are generated with Webpack from files in the src directory.

I've added a developer guide that explains more of the process. Please let me know if any of it doesn't make sense.

https://github.com/abraham/nutmeg-cli/blob/master/DEVELOPER.md

[Rodrigo Silveira]

Thanks