Open a new issue and be sure to include a title and clear description, as much relevant information as possible, and a code sample or a test case demonstrating the expected behavior that is not occurring.
Discussions can be done via github issues or IRC channel #brass-monkey.
Fork the project on GitHub and check out your copy locally.
git clone [email protected]:username/nodeshift.git
cd nodeshift
git remote add upstream https://github.com/nodeshift/nodeshift.git
Create a feature branch and start hacking:
git checkout -b my-contrib-branch
Writing good commit logs is important. A commit log should describe what changed and why. Follow these guidelines when writing one:
- The first line should be 50 characters or less and contain a short description of the change.
- Keep the second line blank.
- Wrap all other lines at 72 columns.
Example of commit message:
fix a bug with download url.
The download url was not using https.
Body of commit message is a few lines of text, explaining things
in more detail, possibly giving some background about the issue
being fixed, etc. etc.
The body of the commit message can be several paragraphs, and
please do proper word-wrap and keep columns shorter than about
72 characters or so. That way `git log` will show things
nicely even when it is indented.
Use git rebase to sync your work from time to time.
git fetch upstream
git rebase upstream/master
Bug fixes and features should come with tests.
The tests are on test directory.
npm install
npm test
git push origin my-contrib-branch
Go to https://github.com/yourusername/nodeshift and select your feature branch. Click the 'Pull Request' button and fill out the form.