Skip to content

Commit

Permalink
Merge pull request #78 from ggtakec/update_templ_doc
Browse files Browse the repository at this point in the history
Updated issue/pullrequest templates and README
  • Loading branch information
ggtakec authored Dec 19, 2022
2 parents f8d2dac + 3bda2fc commit 980cbfd
Show file tree
Hide file tree
Showing 6 changed files with 103 additions and 23 deletions.
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---

<!-- -------------------------------------------------------------
[ REQUEST BEFORE POSTING ]
The following information is very important in order to help us to
help you.
Omission of the following details may delay your support request.
-------------------------------------------------------------- -->

### Describe the bug
<!-- -------------------------------------------------------------
Please describe the details of the bug, the problem, etc. to the
extent that you understand.
-------------------------------------------------------------- -->

### Reproduction steps
<!-- -------------------------------------------------------------
Please provide any steps to reproduce this issue.
-------------------------------------------------------------- -->

### Environment
<!-- -------------------------------------------------------------
Please describe to the best of your knowledge the environment in
which the problem occurred.
-------------------------------------------------------------- -->

#### Version of K2HASH being used (`k2hlinetool -libversion`)
```
```

#### Distro (`cat /etc/os-release`)
```
```

### Relevant Issues/Pull Requests (if applicable)
<!-- -------------------------------------------------------------
If there are Issues or Pull Requests related to this Issue, please
list it.
-------------------------------------------------------------- -->

### Additional context
<!-- -------------------------------------------------------------
Add any other context(ex. logs) about the problem here.
-------------------------------------------------------------- -->
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''
---

### Feature request
<!-- -------------------------------------------------------------
Please let us know your ideas, such as features you want to improve,
features to add, etc.
-------------------------------------------------------------- -->

### Relevant Issues/Pull Requests (if applicable)
<!-- -------------------------------------------------------------
If there are Issues or Pull Requests related to this Issue, please
list it.
-------------------------------------------------------------- -->

### Additional context/explanation
<!-- -------------------------------------------------------------
Please provide any additional context/explanation.
-------------------------------------------------------------- -->
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/support_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Support request
about: Request support for how to use, etc.
title: ''
labels: help wanted
assignees: ''
---

### What kind of support do you need?
<!-- -------------------------------------------------------------
Please describe in detail what you need help with.
-------------------------------------------------------------- -->

### Relevant Issues/Pull Requests (if applicable)
<!-- -------------------------------------------------------------
If there are Issues or Pull Requests related to this Issue, please
list it.
-------------------------------------------------------------- -->
14 changes: 9 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
#### Relevant Issue (if applicable)
(If there are Issues related to this PullRequest, please list it.)

#### Details
(Please describe the details of PullRequest.)
### Relevant Issues/Pull Requests (if applicable)
<!-- -------------------------------------------------------------
If there are Issues or Pull Requests related to this Pull Request,
please list it.
-------------------------------------------------------------- -->

### Details
<!-- -------------------------------------------------------------
Please describe the details of PullRequest.
-------------------------------------------------------------- -->
3 changes: 2 additions & 1 deletion README
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ K2HASH - NoSQL Key Value Store(KVS) library

### Overview
K2HASH is NoSQL(key value store) library and tools for this library by
Yahoo! JAPAN. K2HASH is following specifications.
Yahoo! JAPAN.
K2HASH is following specifications.

### Feature
- Supports multi-threading and multi-processing program.
Expand Down

0 comments on commit 980cbfd

Please sign in to comment.