Giter VIP home page Giter VIP logo

git-journal's Introduction

Git Journal

Journalling project development with the power of git

Tired of piles of notes spread across txt files, emails and TODOs? With git-journal you can organize your ideas in a neat way that:

  • tracks history
  • allows you to make branches and not forget about what you've done before
  • trace back your though process
  • allows you to merge successive ideas into mainstream
  • gives you a whole lot of possibilities that git gives you

Installation

Just issue make install. It will simply copy git-journal script into /usr/local/bin. To uninstall just do make uninstall.

Usage

Setup journal for your git repo

git journal init [journal dir]

This will create journal directory inside your repo and add "journal" section to your repo config (not global, of course). If you don't specify [journal dir] argument there will be created journal directory by default.

If you already have journal repo hosted elsewhere, you can clone it:

git journal clone [repo path] [journal dir]

journal directory is a git repo itself and it is not tracked by your parent repo, so you don't have to modify gitignore.

The new commands for journal mode of git are:

  • git journal add
  • git journal edit

These are just wrappers around git commit with some sanity checks.

Adding a new record to your journal is a simple

git journal add

This will invoke a text editor where you can write and edit a message.

Journal records are commits inside journal repository with a notable exceptions:

  • It does NOT change containing parent repo
  • It does NOT create any files (there are no tree objects)
  • It's a same old git history that you can play with

If your project got a new side idea just go to journal repo and branch!

cd journal
git checkout -b what-if

Later you can merge it back as usual

git checkout master
git merge --no-ff what-if

git-journal's People

Contributors

dzeban avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.