This project would not exist without all of its users and contributors.
If you have ideas on how to make the configuration easier to maintain or improve its performance, do not hesitate to fork and send pull requests.
If you want to contribute to the project, check out the list of open issues
- raise an issue
- suggest a feature
If you would like to contribute code to the project:
- A bit of background reading:
- Setting up Git for Windows and connecting to GitHub
- The Simple Guide to Git
- How to GitHub: Fork, Branch, Track, Squash and Pull Request
- Write good commit messages.
- Fork the repository
- Make some changes to the code base
- Send us a Pull Request once you're happy with it
We'll do a bit of a code review before accepting your patch.
- A README.md must be present.
- Large functions must be placed in a functions directory.
- Functions that take arguments must have completion.
- A screenshots section must be present in the file header.
- The pull request description must have must have embedded screenshots.
Use of Git Flow is not required for contributing to dotzsh, particularly
if you're submitting a bug-fix or small feature. Its use is recommended for
larger changes where
develop might move on whilst you're completing your work.
Configuring Git Flow
There is a set of helper scripts that will work on both Unix-based
operating systems and Windows. Follow the appropriate
installation instructions for your operating system, and configure your
working copy repository for use with Git Flow by typing
git flow init.
Accept all the default options to the questions that it asks you.
Using Git Flow
Pick a feature or bug to work on and create a new branch for that work by
git flow feature start <featurename>. This will create you a new
feature branch for your work called
feature/<featurename>, and you can use
git as usual from this point.
Once your feature is finished, type
git flow feature publish <featurename>.
This will copy the feature branch to your
origin repository on GitHub and
you will then be able to submit a pull request to have it merged into dotzsh's
Note: do not use
git flow feature finish <featurename>!
This will automatically merge your feature branch back into
delete the feature branch, making it harder for you to submit your pull
If you wish to update your published feature branch after the initial publish,
use a regular
git push origin feature/<featurename>. This will also update
your pull request if you have one open for that branch.
If you find dotzsh's
develop branch has moved on, and you need/want to take
advantage of the changes made there, you can update your feature branch as
Ensure you have a remote configured for the upstream repository.
git remote add upstream git://github.com/dotphiles/dotzsh.git
Update your local repository with the upstream refs.
git pull upstream develop:develop`
Rebase your feature branch on top of the new
git flow feature rebase
There is a lot of help available for Git Flow, which can be accessed by typing
git flow feature help.