docs: add issue and PR templates

This commit is contained in:
jinhojang6 2023-09-27 23:39:57 +09:00
parent 654def2a8b
commit ab0dfc0fb1
4 changed files with 81 additions and 3 deletions

37
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@ -0,0 +1,37 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
### Summary:
[Provide a brief summary of the issue.]
### Environment:
- Operating System:
- Browser (If applicable):
- Project Version:
- Additional relevant information:
### Steps to Reproduce:
1. [First step]
2. [Second step]
3. [And so on…]
### Expected Behavior:
[Provide a detailed description of the expected behavior.]
### Actual Behavior:
[Provide a detailed description of the actual behavior you are experiencing.]
### Screenshots (if applicable):
[Attach screenshots to help illustrate the issue.]
### Additional Information:
[Any additional information, configuration, or data that might be necessary to reproduce the issue.]
### Potential Solutions (if applicable):
[Optional: Provide any thoughts or ideas you might have on potential solutions to the issue.]

View File

@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---
### Feature Request:
[Quick summary of the feature you would like to be added.]
### Why is this feature important?
[Explain why you think this feature would be beneficial.]
### How should it work?
[Briefly describe how you envision this feature working, or how you would like it to be implemented.]

24
.github/pull_request_template.md vendored Normal file
View File

@ -0,0 +1,24 @@
### Description:
[Provide a brief description of the changes in the pull request.]
### Related Issue(s):
[Link to the related Issue(s), if any.]
### Changes Included:
- [ ] Bugfix (a change that fixes an issue)
- [ ] New feature (a change that adds new functionality)
- [ ] Refactoring (a change that improves code quality and/or architecture)
- [ ] Other (explain below)
### Implementation Details:
[Explain any new decisions made during the implementation of the changes.]
### Testing:
[Describe how the changes have been tested.]
### Checklist:
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] My changes generate no new warnings
- [ ] Any dependent changes have been merged and published in downstream modules

View File

@ -11,9 +11,9 @@ description: Codex is building a decentralised durability storage engine
[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)](#stability)
[![CI](https://github.com/status-im/nim-codex/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/status-im/nim-codex/actions?query=workflow%3ACI+branch%3Amain)
<!-- [![CI](https://github.com/status-im/nim-codex/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/status-im/nim-codex/actions?query=workflow%3ACI+branch%3Amain)
[![Codecov](https://codecov.io/gh/status-im/nim-codex/branch/main/graph/badge.svg?token=XFmCyPSNzW)](https://codecov.io/gh/status-im/nim-codex)
[![Discord](https://img.shields.io/discord/895609329053474826)](https://discord.gg/CaJTh24ddQ)
[![Discord](https://img.shields.io/discord/895609329053474826)](https://discord.gg/CaJTh24ddQ) -->
## Build and run
@ -22,7 +22,7 @@ For detailed instructions on preparing to build nim-codex see [*Building Codex*]
To build the project, clone it, and run:
```bash
make update && make exec
build/codex
```
The executable will be placed under the `build` directory under the project root.