@beauraines/sprint-tracker 0.6.2 → 0.6.4

package/CHANGELOG.md

@@ -2,7 +2,14 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-### [0.6.2](https://bitbucket.org/beauraines/sprint-tracker/compare/v0.6.1...v0.6.2) (2023-12-07)
+### [0.6.4](https://bitbucket.org/beauraines/sprint-tracker/compare/v0.6.3...v0.6.4) (2023-12-07)
+
+
+### Bug Fixes
+
+* **config:** creates file when one doesn't exist ([#44](https://bitbucket.org/beauraines/sprint-tracker/issues/44)) ([1b3b525](https://bitbucket.org/beauraines/sprint-tracker/commit/1b3b525ecc7da1c884417cabf5c1b5aa06c01025)), closes [#42](https://bitbucket.org/beauraines/sprint-tracker/issues/42)
+
+### [0.6.3](https://bitbucket.org/beauraines/sprint-tracker/compare/v0.6.1...v0.6.3) (2023-12-07)
 
 
 ### Features
@@ -18,6 +25,7 @@ All notable changes to this project will be documented in this file. See [standa
 * compensates for unestimated work-items ([#19](https://bitbucket.org/beauraines/sprint-tracker/issues/19)) ([79bfa68](https://bitbucket.org/beauraines/sprint-tracker/commit/79bfa68bc30a6244416af10fcb26007957ee0f0f))
 * makes config path work cross-OS ([4fae74b](https://bitbucket.org/beauraines/sprint-tracker/commit/4fae74b4ba45f5bf0f6d62c7b924d2ead01d0d73))
 * Prettify output with cli-table3 ([682b72f](https://bitbucket.org/beauraines/sprint-tracker/commit/682b72f343c4cb34e8b36bb907065993f09b4c70)), closes [#5](https://bitbucket.org/beauraines/sprint-tracker/issues/5)
+* **README:** adds installation instructions ([7ed182f](https://bitbucket.org/beauraines/sprint-tracker/commit/7ed182fa7676aa6d5b37f001d4d413e86fe9ee83))
 * removes description from sprint display ([1ebd19e](https://bitbucket.org/beauraines/sprint-tracker/commit/1ebd19e3aca1c9dbaed021b84963b4dc7aa3e135))
 * saves feature team backlog to a file ([01e79b5](https://bitbucket.org/beauraines/sprint-tracker/commit/01e79b53b9e067e33151e6d4f38b47900c7439ae))
 * scripts to create visualizations ([a6aa4f8](https://bitbucket.org/beauraines/sprint-tracker/commit/a6aa4f861e526a5abb7fc9cb77af2c719aae1b24))

package/README.md

@@ -49,6 +49,11 @@ brew install docker sqlite
 docker pull rocker/tidyverse
 ```
 
+## Installation Instructions
+
+The sprint-tracker can be installed with `npm -g i @beauraines/sprint-tracker` to be used locally. Once you've installed it, follow the [General Usage](#general-usage) instructions. If you're going to contribute to the package, see [Installation and Setup for Development](#installation-and-setup-for-development).
+
+
 ## General Usage
 
 1. Update the config file with the path to the database `sprint-tracker config`. The database doesn't need to exist yet. This step only needs to be done the first time.
@@ -92,13 +97,13 @@ Non-working days and PTO will be recorded to be able to normalize Sprints with d
 
 ### Sprint Outcomes
 
-1. Commitment : Initial sprint commitment
-1. Delivered : Work completed this sprint
-1. Unplanned - Story : All unplanned work brought into the sprint, whether completed or not
-1. Unplanned - Bug : Unplanned work without a pre-existing story that was deemed critical enough to add to the sprint
-1. Descoped : Committed work, removed from the sprint
-1. Carryover : Incomplete, started or unstarted, work from this sprint, assumed that it will carryover to the next sprint
-1. Carryover - External : Work that was carried over due to blockers external to the scrum team. Use of this is optional, as an agile team should be fully self-sufficient.
+1. Commitment: Initial sprint commitment
+1. Delivered: Work completed this sprint
+1. Unplanned - Story: All unplanned work brought into the sprint, whether completed or not
+1. Unplanned - Bug: Unplanned work without a pre-existing story that was deemed critical enough to add to the sprint
+1. Descoped: Committed work, removed from the sprint
+1. Carryover: Incomplete, started or un-started, work from this sprint, assumed that it will carry over to the next sprint
+1. Carryover - External: Work that was carried over due to blockers external to the scrum team. Use of this is optional, as an agile team should be fully self-sufficient.
 
 
 ### ERD
@@ -165,17 +170,18 @@ docker run -it --rm -v ${PROJECT_DIR}:/home/rstudio/projects/ ${IMAGE} su -c 'Rs
 ## Roadmap
 
 1. ~~Build local database using sqlite3~~
-2. ~~Script visualizations, possibly with R, graph-cli, chartsjs, PowerBI or AWS QuickSight~~
+2. ~~Script visualizations, possibly with R, graph-cli, chartsjs, PowerBI, or AWS QuickSight~~
 3. [Backlog health tracking](https://github.com/beauraines/sprint-tracker/issues/36)
 4. Write API for adding data
 5. Write API for getting visualizations
 6. ~~Create database migrations~~
 7. Deploy to cloud
 8. Add sprint metrics
-    1. Average velocity over life of project
+    1. Average velocity over the life of the project
     2. Recent average velocity
     3.  90% confidence range. See <https://resources.scrumalliance.org/Article/its-target-forecast>
     4.  Daily points per developer
 
+## Contributing
 
-
+Please feel free to contribute by opening a pull request!

package/cmds/config.js

@@ -13,7 +13,7 @@ const handler = async function () {
     const filename = 'sprintTracker.json'
     const configFile = path.join(homedir(), filename)
 
-    if (helpers.fileExists(configFile)) {
+    if (await helpers.fileExists(configFile)) {
         console.error(`Aborting. Existing configuration file ${configFile} found to not overwrite your values.`)
         process.exit(1)
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/sprint-tracker",
-  "version": "0.6.2",
+  "version": "0.6.4",
   "description": "Database and R visualizations to track sprint performance",
   "main": "cli.js",
   "bin": {