https://github.com/npryce/pottery

It's like Twitter, for recording things that happen in your project, stored in it's version control repository.
https://github.com/npryce/pottery

Last synced: 5 days ago
JSON representation

It's like Twitter, for recording things that happen in your project, stored in it's version control repository.

• Host: GitHub
• URL: https://github.com/npryce/pottery
• Owner: npryce
• License: other
• Created: 2018-08-17T16:37:11.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-10-25T15:09:34.000Z (about 3 years ago)
• Last Synced: 2024-10-31T22:42:24.346Z (12 days ago)
• Language: Shell
• Size: 60.5 KB
• Stars: 94
• Watchers: 4
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
Pottery

=======

It's like Twitter, for recording things that happen in your project, stored in it's version control repository.

[![Build Status](https://travis-ci.org/npryce/pottery.svg?branch=master)](https://travis-ci.org/npryce/pottery)

If you use JetBrains IDEs, you may find the [Pottery Idea Plugin](https://github.com/npryce/pottery-idea-plugin) more convenient.

Quick Start

-----------

[Install Pottery](INSTALL.md).

Use the `pottery` command to record significant events in your project with short,

Twitter-like posts (which we've nicknamed ["sherds"](https://en.wikipedia.org/wiki/Sherd)).

Sherds are stored in a subdirectory of your project as Markdown files. 

The default directory is `docs/project-history`, but you can specify a 

different directory when you initialise the history log.

1. Create a directory in the root of your project:

        pottery init

    This will create a directory named `docs/project-history`

2. Post interesting events

        pottery post Alice joined the project

    This will create a new Markdown file in a dated subdirectory and file

	within `docs/project-directory`.  If you don't write any text after the

	`post` command, Pottery will open the new file for editing in your

    editor of choice (as specified by the VISUAL or EDITOR environment

    variable).

	

4. Post more events, when they occur.

        pottery post Bob left the project

        pottery post The company merged with MegaCorp, stopped selling widgets and started promoting doodads.

    Over time, you will build a record of the non-technical influences that 

	affected the project over its lifetime.

3. For further information, use the built in help:

        pottery help

See the [tests](tests/) for detailed examples.