Third-party patches are essential for keeping cnpmjs.org great.
We want to keep it as easy as possible to contribute changes that
get things working in your environment. There are a few guidelines that we
need contributors to follow so that we can have a chance of keeping on
top of things.
- Make sure you have a GitHub account
- Fork the repository on GitHub
- Create a topic branch from where you want to base your work.
- This is usually the master branch.
- Only target release branches if you are certain your fix must be on that branch.
- To quickly create a topic branch based on master.
Please avoid working directly on the
masterbranch.
- Make commits of logical units and including unit tests.
- Check for unnecessary whitespace with
git diff --checkbefore committing. - Make sure your commit messages are in the proper format.
- Make sure you have added the necessary tests for your changes.
- Run all the tests to assure nothing else was accidentally broken.
- Follow node style guide
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request.
- Make sure travis-ci test pass.