Search before asking

• I have searched in the issues and found no similar issues.

Description

There isn't a lot of information in the README, which will stop us getting traction

Solution

Look at other popular python repos to find good sections to add.

Are you willing to submit PR?

• Yes I am willing to submit a PR!

Search before asking

• I have searched in the issues and found no similar issues.

Description

It could be useful to have a command that allows you to merge to stories. The use case would be if you have two events which are too granular you can then merge them together under a larger story

Solution

Command would look something like

bookshelf [STORY1] [STORY2] [NEWSTORY]

Pseudo code:

Both stories don't exists:
  throw exception
one of the stories is in progress:
  throw exception
merge each of the chapters
create a new story with those chapter 
save the new story
delete the other stories

Are you willing to submit PR?

• Yes I am willing to submit a PR!

They don't come up in here!

Search before asking

• I had searched in the issues and found no similar issues.

Version

0.1.0

What's Wrong?

The install command is pip install bookshelf on the docs

What You Expected?

It should be bookshelf-cli

How to Reproduce?

Check the docs

Anything Else?

No response

Are you willing to submit PR?

• Yes I am willing to submit a PR!

Search before asking

• I have searched in the issues and found no similar issues.

Description

Currently if you start a chapter, you cannot then cancel it. This command is useful to stop and not save chapters.

Solution

The command would be:

bookshelf cancel [STORY]

pseudo code would be something like:

story has no a chapter in progress:
  raise StoryNotInProgressException
remove the current chapter from the story
save story

Are you willing to submit PR?

• Yes I am willing to submit a PR!

Search before asking

• I had searched in the issues and found no similar issues.

Version

n/a

What's Wrong?

Issue template isn't loading

What You Expected?

Issue template to load

How to Reproduce?

Just try and create an issue.

Anything Else?

It's due to an extra quotation mark on line 4. Easy fix.

Are you willing to submit PR?

• Yes I am willing to submit a PR!

Search before asking

• I have searched in the issues and found no similar issues.

Description

We should add the functionality to edit a story.

Solution

I propose the following usage:

bookshelf edit [STORY] [FIELD] 

You should then probably be able to edit the raw json as well, maybe with a --raw-json flag.

Are you willing to submit PR?

• Yes I am willing to submit a PR!

Search before asking

• I have searched in the issues and found no similar issues.

Description

The preformatted terminal examples don't render nicely on smaller screens.

Solution

Look at an improved way of rendering the terminals, potentially a react component

Are you willing to submit PR?

• Yes I am willing to submit a PR!

Search before asking

• I have searched in the issues and found no similar issues.

Description

Add a PR template to standardise PRs

Solution

Use this template

Are you willing to submit PR?

• Yes I am willing to submit a PR!

Search before asking

• I have searched in the issues and found no similar issues.

Description

We can use mutmut to set up running mutation tests. We can run in the pipeline and set a threshold for an allowable mutation amount.

Solution

Could use a workflow similar to below to run mutation tests when a certain label is added:

name: Mutation Testing Workflow

on:
  pull_request:
    types:
      - labeled

jobs:
  mutation-tests:
    if: contains(github.event.pull_request.labels.*.name, 'mutation tests')
    runs-on: ubuntu-latest

    steps:
    - name: 🔄 Checkout code
      uses: actions/checkout@v2

    - name: 🐍 Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: 3.x  # Specify your desired Python version

    - name: 📦 Install dependencies
      run: pip install -r requirements-dev.txt  # Replace with your requirements file

    - name: ❄️ Run Flake8
      run: flake8 .

    - name: 🦠 Run unit tests
      run: mutmut run --CI

Are you willing to submit PR?

• Yes I am willing to submit a PR!

Search before asking

• I have searched in the issues and found no similar issues.

Description

Add dependabot to automatically scan and upgrade the repos dependencies

Solution

Add a dependabot.yaml file

Are you willing to submit PR?

• Yes I am willing to submit a PR!

Search before asking

• I have searched in the issues and found no similar issues.

Description

It would be great if you could autocomplete on each of the story names. It would make writing commands much faster.

Solution

Look at researching into: https://click.palletsprojects.com/en/8.1.x/shell-completion/

Are you willing to submit PR?

• Yes I am willing to submit a PR!

Search before asking

• I have searched in the issues and found no similar issues.

Description

Have the ability to be able to add/remove certain tags from a story.

Solution

Use something like bookshelf [un]tag

Are you willing to submit PR?

• Yes I am willing to submit a PR!