Skip to content

Latest commit

 

History

History
121 lines (91 loc) · 4.95 KB

CONTRIB.md

File metadata and controls

121 lines (91 loc) · 4.95 KB
Raw

Contribute

This project would not exist without all of its users and contributors.

Lots of ideas and code stolen from around the interwebs such as skwp/dotfiles, sorin-ionescu/prezto, robby-russell/oh-my-zsh, holman/dotfiles, mathiasbynens/dotfiles, spf13 and numerous other snippets of code copied and pasted over the years.

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

You can:

  • raise an issue
  • suggest a feature

If you would like to contribute code to the project:

  1. Fork the repository
  2. Create a feature branch to easily amend a pull request later, if necessary.
  3. Make some changes to the code base, write good commit messages.
  4. Squash commits on the topic branch before opening a pull request.
  5. Open a pull request that relates to but one subject with a clear title and description in gramatically correct, complete sentences.

Git Flow

We use the Git Flow branching model, first described by nvie, so dotphiles's master branch moves on only at specific points, when we're really sure we want to promote something to production.

Use of Git Flow is not required for contributing to dotphiles, 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 typing 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 dotphiles own develop branch.

Note: do not use git flow feature finish <featurename>!

This will automatically merge your feature branch back into develop and delete the feature branch, making it harder for you to submit your pull request.

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 dotphiles develop branch has moved on, and you need/want to take advantage of the changes made there, you can update your feature branch as follows:

  1. Ensure you have a remote configured for the upstream repository.

    git remote add upstream git://github.com/dotphiles/dotphiles.git

  2. Update your local repository with the upstream refs.

    git pull upstream develop:develop`

  3. Rebase your feature branch on top of the new develop.

    git flow feature rebase

There is a lot of help available for Git Flow, which can be accessed by typing git flow feature help.