Skip to content

Commit

Permalink
updates issues template - readme
Browse files Browse the repository at this point in the history
  • Loading branch information
saxix committed Dec 5, 2024
1 parent 39f6b57 commit ad36e13
Show file tree
Hide file tree
Showing 6 changed files with 138 additions and 1 deletion.
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: 🐞 Bug Report
description: Tell us about something that's not working the way we (probably) intend.
body:
- type: textarea
id: repro
attributes:
label: Steps to Reproduce
description: How can we see what you're seeing? Specific is terrific.
placeholder: |-
1. foo
2. bar
3. baz
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Result
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Result
description: Logs? Screenshots? Yes, please.
validations:
required: true
- type: dropdown
id: product-area
attributes:
label: Product Area
description: Where in the product did you find the bug?
options:
# begin product areas
- 'Unknown'
- 'Data cleaners'
- 'DataCheckers/Validators'
- 'Import data (Aurora/Kobo/RDI)'
- 'Send to HOPE'
- 'Data Cleaner'
- 'Background jobs'
- 'Security/Permission'
# end product areas
validations:
required: true
- type: input
id: version
attributes:
label: Version
placeholder: 21.7.0 ← should look like this (check the footer)
description: What version are you running?
validations:
required: true
- type: markdown
attributes:
value: |-
## Thanks 🙏
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: 💡 Feature Request
description: Tell us about a problem our software could solve but doesn't.
body:
- type: textarea
id: problem
attributes:
label: Problem Statement
description: What problem could Hope Workspace solve that it doesn't?
placeholder: |-
I want to make good espresso, but Hope Workspace doesn't make it.
validations:
required: true
- type: textarea
id: expected
attributes:
label: Solution Brainstorm
description: We know you have bright ideas to share ... share away, friend.
placeholder: |-
Add a blender to Hope Workspace.
validations:
required: false
- type: dropdown
id: product-area
attributes:
label: Product Area
description: What is the most relevant part of the product?
options:
# begin product areas
- 'Unknown'
- 'Data cleaners'
- 'DataCheckers/Validators'
- 'Import data (Aurora/Kobo/RDI)'
- 'Send to HOPE'
- 'Data Cleaner'
- 'Background jobs'
- 'Security/Permission'
# end product areas
validations:
required: true
- type: markdown
attributes:
value: |-
## Thanks 🙏
validations:
required: false
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,33 @@
# hope-country-workspace

[<img src="./docs/src/img/hope_workspace.png" style="margin-left: auto;margin-right: auto;width:300px;display:block"/>](./docs/src/img/hope_workspace.png)

---

[![Test](https://github.com/unicef/hope-country-workspace/actions/workflows/test.yml/badge.svg)](https://github.com/unicef/hope-country-workspace/actions/workflows/test.yml)
[![Lint](https://github.com/unicef/hope-country-workspace/actions/workflows/lint.yml/badge.svg)](https://github.com/unicef/hope-country-workspace/actions/workflows/lint.yml)
[![codecov](https://codecov.io/github/unicef/hope-country-workspace/graph/badge.svg?token=FBUB7HML5S)](https://codecov.io/github/unicef/hope-country-workspace)
[![Documentation](https://github.com/unicef/hope-country-workspace/actions/workflows/docs.yml/badge.svg)](https://unicef.github.io/hope-country-workspace/)
[![Docker Pulls](https://img.shields.io/docker/pulls/unicef/hope-country-workspace)](https://hub.docker.com/repository/docker/unicef/hope-country-workspace/tags)



Hope Workspace fa parte dell'ecosistema [UNICEF HOPE](https://github.com/unicef/hope) e gestisce la fase di importazione e pulizia dei dati del processo di gestione dei beneficiari

### Implemented Features

- Import data from Kobo / Aurora / XLS (RDI format)
- Data validation
- Data cleaning and updates
- Push data to HOPE
- Export/Amend/Import process



### Under analysis future feature (not currently planned)

- Generic XLS/CSV Import
- Deduplication
- Beneficiary contacting process


Do you have an idea? [Open a ticket](https://github.com/unicef/hope-country-workspace/issues/new).
Binary file added docs/src/img/hope_workspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: Documentation
---


[<img src="./img/hope_workspace.png" style="margin-left: auto;margin-right: auto;width:300px;display:block"/>](./docs/src/img/hope_workspace.png)


Hope Workspace fa parte dell'ecosistema [UNICEF HOPE](https://github.com/unicef/hope) e gestisce la fase di importazione e pulizia dei dati del processo di gestione dei beneficiari

0 comments on commit ad36e13

Please sign in to comment.