donejs / donejs/generator-donejs

How to contribute?

Open
#135 9 comments 1 reaction 0 assignees View on GitHub
developer relations help wanted p2 ready
Dominant language
JavaScript
Stars
9
Forks
7
PR merge metrics
No merged PRs in 30d

Description

I would have benefited from a `hacking.md` or **Contributing** section added to the README.

After grokking how `generator-donejs` ties into both `donejs/cli` and `donejs/donejs`, I was able finally to deduce the following steps, and see the result of my edits in `generator-donejs/plugin`:
1. Clone `donejs/generator-donejs`.
2. Run `npm link` within the cloned directory.
3. Make a new temporary directory for testing.
4. Run `npm link generator-donejs` within that new testing directory.
5. Finally, `donejs add plugin` will use the linked generator, because it already exists there.

If there is a better way of setting up this project to hack on it and test generator changes, I'd like to know.

Assuming documentation does not already exist regarding how to set this up, an explanation of these steps would be very helpful for new contributors like me! Thanks 👍

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.