Use Story Points in GitHub Project board without a hassle. No labels or issue title modifications needed.
MIT License
⚠️ DEPRECATED: This project is no longer needed as GitHub issues supports custom fields now. Use number fields to add estimations to your issues and display sum of the field on your board.
Use Story Points in GitHub Project board without a hassle. No labels or issue title modifications needed.
There are plenty of similar tools. However, all existing plugins or scripts I found base on Github labels or tags in task titles, which doesn't look professional. I prepared the script to keep the estimations internal, visible only on GitHub Project boards. The boards can set as private, which means this script allows to show Story Points only for authors or organization members.
The script has the following features:
Current implementation of the script recalculates Story Points every 2 seconds.
NOTE: To reference actual issue, paste a link into the note.
```est
SP: {value}
```
For example, for Story Points value of 3, the actual codeblock is:
```est
SP: 3
```
Currently the plugin doesn't expose official configuration options. As a workaround, you can modify the following lines of the script:
const refreshInterval = 2000;
const highlightNotEstimatedCards = true;
const showTotalBoardStoryPoints = true;
// the column cards will be excluded from validation and counting Story Points:
// both from column and board Story Points count.
const excludedColumns = ["Inbox"];
// the column cards will be validated as usual and the column summary will be visible,
// but the Story Points from this column won't be counted towards the board total Story Points.
const excludedColumnsFromBoardStoryPointsCount = ["Backlog"];
However, keep in mind that every script update will overwrite your configuration values.
To see a live example, install the script and navigate to the sample GitHub Project.