@beauraines/sprint-tracker 0.6.2 → 0.6.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -1
- package/README.md +7 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
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.
|
|
4
4
|
|
|
5
|
-
### [0.6.
|
|
5
|
+
### [0.6.3](https://bitbucket.org/beauraines/sprint-tracker/compare/v0.6.1...v0.6.3) (2023-12-07)
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
### Features
|
|
@@ -18,6 +18,7 @@ All notable changes to this project will be documented in this file. See [standa
|
|
|
18
18
|
* compensates for unestimated work-items ([#19](https://bitbucket.org/beauraines/sprint-tracker/issues/19)) ([79bfa68](https://bitbucket.org/beauraines/sprint-tracker/commit/79bfa68bc30a6244416af10fcb26007957ee0f0f))
|
|
19
19
|
* makes config path work cross-OS ([4fae74b](https://bitbucket.org/beauraines/sprint-tracker/commit/4fae74b4ba45f5bf0f6d62c7b924d2ead01d0d73))
|
|
20
20
|
* Prettify output with cli-table3 ([682b72f](https://bitbucket.org/beauraines/sprint-tracker/commit/682b72f343c4cb34e8b36bb907065993f09b4c70)), closes [#5](https://bitbucket.org/beauraines/sprint-tracker/issues/5)
|
|
21
|
+
* **README:** adds installation instructions ([7ed182f](https://bitbucket.org/beauraines/sprint-tracker/commit/7ed182fa7676aa6d5b37f001d4d413e86fe9ee83))
|
|
21
22
|
* removes description from sprint display ([1ebd19e](https://bitbucket.org/beauraines/sprint-tracker/commit/1ebd19e3aca1c9dbaed021b84963b4dc7aa3e135))
|
|
22
23
|
* saves feature team backlog to a file ([01e79b5](https://bitbucket.org/beauraines/sprint-tracker/commit/01e79b53b9e067e33151e6d4f38b47900c7439ae))
|
|
23
24
|
* scripts to create visualizations ([a6aa4f8](https://bitbucket.org/beauraines/sprint-tracker/commit/a6aa4f861e526a5abb7fc9cb77af2c719aae1b24))
|
package/README.md
CHANGED
|
@@ -49,6 +49,11 @@ brew install docker sqlite
|
|
|
49
49
|
docker pull rocker/tidyverse
|
|
50
50
|
```
|
|
51
51
|
|
|
52
|
+
## Installation Instructions
|
|
53
|
+
|
|
54
|
+
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).
|
|
55
|
+
|
|
56
|
+
|
|
52
57
|
## General Usage
|
|
53
58
|
|
|
54
59
|
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.
|
|
@@ -177,5 +182,6 @@ docker run -it --rm -v ${PROJECT_DIR}:/home/rstudio/projects/ ${IMAGE} su -c 'Rs
|
|
|
177
182
|
3. 90% confidence range. See <https://resources.scrumalliance.org/Article/its-target-forecast>
|
|
178
183
|
4. Daily points per developer
|
|
179
184
|
|
|
185
|
+
## Contributing
|
|
180
186
|
|
|
181
|
-
|
|
187
|
+
Please feel free to contribute by opening a pull request!
|