You're encouraged to submit pull requests, propose features and discuss issues.
In the examples below, substitute your Github username for contributor in URLs.
Fork the project on Github and check out your copy.
git clone https://github.com/contributor/node-meraki-dashboard.git
cd node-meraki-dashboard
git remote add upstream https://github.com/tejashah88/node-meraki-dashboard.git
Ensure that you can build the project and run tests.
npm install
npm test
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
git checkout master
git pull upstream master
git checkout -b my-feature-branch
Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Tests live under test.
We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
Implement your feature or bug fix.
Make sure that npm test completes without errors.
Document any external behavior in the README.
Make sure git knows your name and email address:
git config --global user.name "Your Name"
git config --global user.email "[email protected]"
Writing good commit logs is important. A commit log should describe what changed and why.
git add ...
git commit
git push origin my-feature-branch
Go to https://github.com/tejashah88/node-meraki-dashboard and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
Add more commits or amend your previous commit with any changes.
Once you have a pull request number add a commit to record your change in the CHANGELOG.md, don't worry if you forget, Travis-CI will remind you :)
git commit --amend
git push origin my-feature-branch -f
If you've been working on a change for a while, rebase with upstream/master.
git fetch upstream
git rebase upstream/master
git push origin my-feature-branch -f
Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
Please do know that we really appreciate and value your time and work. We love you, really.