Thank you for considering to contribute to Udacimak!
-
Create a branch identifying the issue/feature you're working on:
#ISSUE_NUMBER-DESCRIPTION
Example:
#1-issue-description
-
Uninstall
udacimak
if you have installed it globally:npm uninstall -g udacimak
-
Install Node and npm. Installing via nvm is highly recommended:
-
Install required dependencies:
npm install
-
Create symlink for the package folder so that you can run
udacimak
command:npm link
Run
udacimak --help
and make sure that it works
Now you can start coding!
If this error occur:
npm ERR! code ENOENT
npm ERR! syscall chmod
npm ERR! path C:\Users\User\AppData\Roaming\npm\node_modules\udacimak\lib\index.js
npm ERR! errno -4058
npm ERR! enoent ENOENT: no such file or directory, chmod 'C:\Users\User\AppData\Roaming\npm\node_modules\udacimak\lib\index.js'
npm ERR! enoent This is related to npm not being able to find a file.
npm ERR! enoent
Run script build to fix the issue:
npm run-script build
Please commit with clear commit messages. Udacimak doesn't have a change log file for each version release. The commits are the way to read changes in a version, so clear and concise commit messages are important.
Make sure you run:
npm run link
for Javascript style checknpm test
and make sure all tests pass
- Push your commits to Github
- Create a pull request
By contributing, you agree that your contributions will be licensed under its MIT License.