Skip to content

Commit

Permalink
docs: updates pull-request & issue template(s) (#51)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ephigenia authored Jul 29, 2022
1 parent d0fc3a8 commit 2f87de7
Show file tree
Hide file tree
Showing 9 changed files with 108 additions and 70 deletions.
15 changes: 15 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Lines starting with '#' are comments.
# Each line is a file pattern followed by one or more owners.

# More details are here: https://help.github.com/articles/about-codeowners/

# The '*' pattern is global owners.

# Order is important. The last matching pattern has the most precedence.
# The folders are ordered as follows:

# In each subsection folders are ordered first by depth, then alphabetically.
# This should make it easy to add new rules without breaking existing ones.

# Global owners
* Ephigenia
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# using issue form https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
name: 🐛 Bug Report
description: Create a report to help to improve the project
title: 'bug: '
labels:
- bug
assignees:
- Ephigenia
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the [existing issues](https://github.com/Ephigenia/kontist-cli/issues)
required: true
- type: textarea
attributes:
label: Current Behavior
description: A clear description of what the bug is and how it manifests.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A clear description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Steps to Reproduce
description: Please explain the steps required to duplicate this issue.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: true
- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS**: Ubuntu 20.04
- **Node**: 13.14.0
- **npm**: 7.6.3
value: |
- OS:
- Node:
- npm:
render: markdown
validations:
required: false
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: 🤔 Support Question
url: https://github.com/Ephigenia/kontist-cli/discussions
about: This issue tracker is not for support questions. Please post your question in the discussions
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: 💡 Feature Request
description: Suggest an idea for the project
title: 'feat: '
labels:
- enhancement
assignees:
- Ephigenia
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the [existing issues](https://github.com/Ephigenia/kontist-cli/issues)
required: true
- type: textarea
attributes:
label: Describe the Feature Request
description: A clear and concise description of what the feature does.
validations:
required: true
File renamed without changes.
50 changes: 0 additions & 50 deletions .github/PULL_REQUEST_TEMPLATE/bug.md

This file was deleted.

4 changes: 4 additions & 0 deletions .github/workflows/gitleaks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,9 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: gitleaks-action
uses: zricethezav/gitleaks-action@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
11 changes: 10 additions & 1 deletion source/cli-transfer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import args from './lib/arguments';
import { createAccountClient } from './lib/client';
import { OutputFormat, print, printF } from './lib/output';
import { BIN_NAME } from './lib/constants';
import { formatCurrency } from './lib/format';

const program = new Command();

Expand Down Expand Up @@ -98,7 +99,15 @@ async function run(
// TODO double confirm high amount(s)?

if (!options.yes) {
print('Please confirm that you want to make the following transfer:\n');
// bold
const amount = formatCurrency(
parameters.amount,
config.get('locale') as string,
config.get('currency'),
);
print(
`Please confirm that you want to transfer ${amount} the following transfer:\n`,
);
print(parameters);
// TODO research common option display, uppercase for default, but which order
// TODO add option to disable confirmation
Expand Down

0 comments on commit 2f87de7

Please sign in to comment.