How to contribute to github-keygen
?
Patches are welcome!
They must be built against the master
branch, then submitted as pull requests at GitHub.
The documentation is written using the POD format. Use the perldoc
tool to render it in a terminal:
perldoc CONTRIBUTING.pod
- 1. Get the source
-
git clone --origin upstream git://github.com/dolmen/github-keygen.git cd github-keygen git checkout master
- 2. Install build dependencies
-
Not required for doc patches.
curl -L https://cpanmin.us | perl - --installdeps --with-develop .
- 3. Make your fix/feature
-
git checkout -b <my-patch> master $EDITOR bin/github-keygen # Test... bin/github-keygen ... # Run the author testsuite prove -v xt git commit
- 4. Setup a fork
- 4.1. Fork the project on GitHub
- 4.2. Link your local repo to your fork (just once)
-
(You are using
github-keygen
isn't it?)git remote add github <github-user>.git.luolix.top:<github-user>/github-keygen.git
- 5. Submit your work
- 5.1 Push!
-
git push github <my-patch>
- 5.2 Submit a pull request on GitHub
- 6. Loop
-
Redo from step 3.
Bump
$VERSION
git checkout master # Bump version number $EDITOR bin/github-keygen # Update changelog $EDITOR README.pod git add bin/github-keygen README.pod git commit
Release
git checkout master ./release.pl git push origin master release git push origin --tags