.github: adapt project documentations to Github Discussions

This commit is contained in:
Jesse Chan
2020-12-09 13:44:49 +08:00
parent 8523572c2b
commit d5a2a0143d
39 changed files with 17 additions and 113 deletions

View File

@@ -1,10 +1,6 @@
# Contributing
We love contributions from everyone.
By participating in this project,
you agree to abide by the thoughtbot [code of conduct].
[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
# Issue
@@ -13,24 +9,3 @@ See [ISSUE_TEMPLATE](ISSUE_TEMPLATE).
# Pull request
See [PULL_REQUEST_TEMPLATE.md](PULL_REQUEST_TEMPLATE.md).
# Code quality
- Be sure to use 2 spaces instead of tabulations.
# Labels
| Category | Label(s) | Color(s) |
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| Platform | ![](labels/bsd.png) ![](labels/docker.png) ![](labels/linux.png) ![](labels/macOS.png) ![](labels/windows.png) | #BFD4F2 |
| Problems | ![](labels/bug.png) ![](labels/security.png) | #EE3F46 |
| Severity | ![](labels/critical.png) | #B60205 |
| Type | ![](labels/code.png) ![](labels/design.png) ![](labels/documentation.png) ![](labels/test.png) | #FFC274 |
| Feedback | ![](labels/discussion.png) ![](labels/question.png) | #CC317C |
| Improvements | ![](labels/enhancement.png) ![](labels/optimization.png) ![](labels/performance.png) | #5EBEFF |
| Help | ![](labels/help%20wanted.png) | #76C3A9 |
| Additions | ![](labels/feature.png) | #90C954 |
| Pending | ![](labels/can't%20reproduce.png) ![](labels/in%20progress.png) ![](labels/more%20info%20needed.png) ![](labels/waiting%20feedback.png) ![](labels/watchlist.png) | #FBCA04 |
| Inactive | ![](labels/duplicate.png) ![](labels/invalid.png) ![](labels/not%20a%20bug.png) ![](labels/on%20hold.png) ![](labels/wontfix.png) | #D2DAE1 |
**Note (if there is a need to add labels)**: in order to take a sharp screenshot of labels with Firefox: Right click the label => Inspect element => Right click the element on the inspector => Screenshot Node

View File

@@ -1,16 +0,0 @@
---
name: '💡 Feature Request'
about: 'Suggest an idea for this project'
---
Type: Feature Request
- [ ] If you want to contribute to the project please review the [contributing guidelines](https://github.com/jesec/flood/blob/master/.github/CONTRIBUTING.md).
## Summary
<!--- Provide a general summary of the feature in the Title above -->
## Idea of implementation
<!--- Suggest ideas how to implement the addition or change -->

View File

@@ -1,8 +0,0 @@
---
name: '🔒 Security Vulnerability'
about: 'Report a security vulnerability in flood'
---
PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY, SEE BELOW.
If you discover a security vulnerability within flood, please send an e-mail to @jesec.

View File

@@ -1,8 +0,0 @@
---
name: '❓ Question'
about: 'Ask your questions here'
---
Type: Question
## Question

View File

@@ -1,8 +0,0 @@
---
name: '🎙️ Discussion'
about: 'Start a discussion here'
---
Type: Discussion
## Discussion

View File

@@ -1,6 +0,0 @@
---
name: '🆘 Support'
about: 'Ask for help on Discord'
---
If you need support, ask on Discord https://discord.gg/Z7yR5Uf

14
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,14 @@
blank_issues_enabled: true
contact_links:
- name: 💡 Feature Request
url: https://github.com/jesec/flood/discussions/new
about: Share ideas for new features
- name: ❓ Question
url: https://github.com/jesec/flood/discussions/new
about: General questions
- name: 🎙️ Discussion
url: https://github.com/jesec/flood/discussions/new
about: Start a discussion here
- name: 🆘 Support
url: https://discord.gg/Z7yR5Uf
about: Join Discord for real-time support

View File

@@ -6,22 +6,11 @@
## Related Issue
<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- Please link to the issue here: -->
<!--- Optional -->
## Motivation and Context
## Screenshots
<!--- Why is this change required? What problem does it solve? -->
## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->
## Screenshots (if appropriate):
<!--- Optional -->
## Types of changes
@@ -30,15 +19,3 @@
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have read the **CONTRIBUTING** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.

BIN
.github/labels/bsd.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 946 B

BIN
.github/labels/bug.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 856 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 972 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 996 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 999 B

View File

@@ -1,16 +0,0 @@
# Labels
| Category | Label(s) | Color(s) |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------ | -------- |
| Platform | ![](bsd.png) ![](docker.png) ![](linux.png) ![](macOS.png) ![](windows.png) | #BFD4F2 |
| Problems | ![](bug.png) ![](security.png) | #EE3F46 |
| Severity | ![](critical.png) | #B60205 |
| Type | ![](code.png) ![](design.png) ![](documentation.png) ![](test.png) | #FFC274 |
| Feedback | ![](discussion.png) ![](question.png) | #CC317C |
| Improvements | ![](enhancement.png) ![](optimization.png) ![](performance.png) | #5EBEFF |
| Help | ![](help%20wanted.png) | #76C3A9 |
| Additions | ![](feature.png) | #90C954 |
| Pending | ![](can't%20reproduce.png) ![](in%20progress.png) ![](more%20info%20needed.png) ![](waiting%20feedback.png) ![](watchlist.png) | #FBCA04 |
| Inactive | ![](duplicate.png) ![](invalid.png) ![](not%20a%20bug.png) ![](on%20hold.png) ![](wontfix.png) | #D2DAE1 |
Note: in order to take a sharp screenshot of labels with Firefox: Right click the label => Inspect element => Right click the element on the inspector => Screenshot Node

Binary file not shown.

Before

Width:  |  Height:  |  Size: 826 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 964 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 913 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.2 KiB