Skip to content

Passeriform/GodWit

Repository files navigation

GodWit

crate docs build codecov maintenance

homepage repo

A hackable yet sane project manager and automation suite. GodWit follows an unintrusive philosophy with maximal exposure points to get the best of both end-user and developer worlds.

Godwit is a config driven project assets and states manager suite. It supports a pluggable environment to work with multiple plugins. Godwit also features diff-snipping to trim out unwanted operations from track history. This command is a cli front to godwit core, daemon and other plugins.

It tracks changes in applications across the system deemed crucial for project development. The application can be used as knowledge compilation tool and can be used to provide meaningful analytics on projects.

Godwit uses terms like state to represent a container that can either contain a project and its details or another such container. The complete list of all such containers is represented using a state-graph.

Install

release aur debian homebrew

GodWit is available on AUR and PPA repositories.

Simply install it using

$ yay -Syu godwit

OR

$ sudo add-apt-repository ppa:passeriform/ppa
$ sudo apt update
$ sudo apt install godwit

Use

Begin with initializing GodWit on your general working directory.

$ godwit init

Try adding a new project.

$ godwit add @organization/project ~/projects/project

GodWit automatically tracks the project for any development and gives a rundown of the info after tracking.

$ godwit status -v

Contributing

issues pull-requests

If you want to contribute, start by cloning this repository.

    git clone https://github.com/Passeriform/GodWit Godwit

Checkout to a new branch.

    # Use kebab-case categorization format.


    # Ex: A new feature.
    git checkout feature-<feature>

    # Ex: A bugfix.
    git checkout bugfix-<bug>

    # Ex: A meta update.
    git checkout meta-<title>

    # Ex: A documentation update.
    git checkout docs-<title>

    # Ex: A CI update.
    git checkout ci-<title>

Do your thing...

Code up

Squash commits and issue a PR at https://github.com/Passeriform/GodWit

License

license

Licensed under either of

at your option.

Credition

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.