|Classes of Jason Gerfen||Node nmap||CONTRIBUTING.md||Download|
Contributing to node-libnmap
This document will guide you through the contribution process.
Step 1: Fork
Fork the project on GitHub and check out your copy locally.
Keep your local fork update to date using the
For developing new features and bug fixes, the
Step 2: Branch
Create a feature branch and start hacking:
The branch name should be descriptive about the fixes/features it will address.
Step 3: Commit
Make sure git knows your name and email address:
Writing good commit logs is important. A commit log should describe what changed and why. Follow these guidelines when writing one:
A good commit log can look something like this:
The header line should be meaningful; it is what other people see when they
Check the output of
Step 4: Rebase
Step 5: Test
Bug fixes and features should come with tests. Add your tests in the test directory. Look at other tests to see how they should be structured.
Step 6: Push
Go to https://github.com/yourusername/node-libnmap and select your feature branch. Click the 'Pull Request' button and fill out the form.
Pull requests are usually reviewed within a few days. If there are comments to address, apply your changes in a separate commit and push that to your feature branch. Post a comment in the pull request afterwards; GitHub does not send out notifications when you add commits.