Giter Club home page Giter Club logo

tp's Introduction

A-Bash Book

CI Status

Ui

Description

This is a project for bash-savvy users who are familiar with Command-Line-Interface. We hope that with Bash-like commands, users who enjoy the high speed workflow of executing bash commands can be as seamless and easy to use in our project.

Usages

  • as a CLI integrated address book.
  • contact tracker to better manage your contacts and relationships.

Setup

[coming soon]

Features

[coming soon]

Acknowledgement

This project is based on the AddressBook-Level3 project created by the SE-EDU initiative.

tp's People

Contributors

zhiyuan-amos avatar pyokagan avatar yamgent avatar tanboonji avatar yaowei-soc avatar damithc avatar justgnohug avatar darkdestry-t avatar oeiyiping avatar m133225 avatar mightycupcakes avatar yamidark avatar rinder5 avatar j-lum avatar eugenepeh avatar limmlingg avatar sijie123 avatar chao1995 avatar vivekscl avatar lejolly avatar yl-coder avatar fzdy1914 avatar pierceandy avatar ndt93 avatar edmundmok avatar kychua avatar wltan avatar alexlmeow avatar okkhoy avatar lixiaoooowei avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar

tp's Issues

Add common conventions into Developer Guide

Git Commit Naming Convention

For Git commit naming convention, add https://www.conventionalcommits.org/en/v1.0.0/
Example:
docs: Update AboutUs to include EOL vs docs: update AboutUs to include EOL @ cc99160

  • Discuss & standardize Git commit naming convention
  • Document naming convention for easy reference

Git Branch Naming Convention

For Git branch naming convention, no particular convention. My preference is to follow this convention:

  • feature branches feature/{issue number}-{name}
  • hotfix branches hotfix/{issue number}-{name}
  • documentation branches docs/{issue number}-{name}

Example:

  • justgnohUG:docs/add-image

  • oeiyiping:docs/update-aboutus

  • darkdestry-t:docs/aboutus-image

  • yaowei-soc:docs/41-profile-photo

  • tanboonji:docs/34-user-guide

  • Discuss & standardize Git branch naming convention

  • Document naming convention for easy reference

Pull Request Naming Convention

We currently do not have a convention for naming PR. An example can be https://namingconvention.org/git/pull-request-naming.html

#[Ticket_ID] PR description

  • Discuss & standardize PR naming convention
  • Document naming convention for easy reference

Edit contact requires the contact index

I want to edit a contact based on the person’s name which I am familiar with, rather than an index that I have to look to know

As a user, I should be able to edit the contact by entering the person’s name

Finding friends are difficult

As the user I should be able to find my friends without typing their exact full name so that I can find my friends easily.

I want to share a contact

As a user, I may want to share a contact with others

I should be able to export the contact for sharing

Add tags (bulk) to multiple friends

Having existing tags, I would like to add multiple friends to the existing tag quickly.

Tag Command:

  • tag all
  • tag [INDEX ...]

Flags:
-a to add
-d to delete

Note that a limitation with tag names is that it cannot contain hyphens, so words like "human-resource" will not work.

Remembering the commands and arguments is hard

As a user I should be shown a list of commands or arguments that I can use such that I don't have to remember all the possible arguments and commands available.

Update:

  • Listing of the commands is already implemented in #80 however, it does not extend in aliases that was implemented in #73
  • Do we want to extend the autocomplete into the flags (e.g. -p, -a, -n, etc) and arguments (e.g. phone numbers, email addresses, etc)

Add Remarks into storage

As a user I want to add notes about a certain person so that I can remember my relationship with the contact

Finding friends by guessing names is difficult

I think I have a friend called Shawn, but i’m not sure if its Shaun, Shawn or Sean.

As a user I should be able to find my friends that have names with similar spelling easily so that I can find my friends easily.

Delete a contact by Tag

Delete all contacts in a specific tag (Temporary)
After going to an event where I save temporary contacts, for temporary use, I want to delete it fast in one go.

Finding friends by emails are difficult

I think I have a friend with certain email address.

As a user I should be able to find my friends via their email address so that I can quickly send them an email.

Add Image to AboutUs

As a user I want to know who the developers are through visiting the about us page

Delete a contact by name

As a user, I should be able to delete a contact by name so that I don’t need to find the index for the contact.

Redo commands

As a user, I want to be able to move forward an undone change.

Incomplete milestone v1.1 requirements

image

We need to remove all traces of AB3 and update the necessary files

Things to be done:

  • README
  • docs/AboutUs.md
  • docs/_config.yml
  • docs/UserGuide (no traces of AB3)
  • docs/DeveloperGuide (no traces of AB3)

Finding family contacts using tags

I want to view all my contacts that are tagged “family”.

As a user, I should be able to find contacts that are tagged “family”.

Typing commands are long (Aliasing)

I will probably keep using the same few commands and I don’t want to keep typing the same thing.

As a user, I’d like to bind some commands to shorter aliases.

Typing commands are long (AutoComplete)

I will probably keep using the same few commands and I don’t want to keep typing the same thing.

As a user, I’d appreciate some autocomplete feature.

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.