Skip to content

Commit 4d9459e

Browse files
💄Add Github Template (#35)
* complete documentation * ✨ add template * 🚸 improve gh templates * ✏️ fix typo errors in gh templates --------- Co-authored-by: ManiMozaffar <[email protected]>
1 parent d8b9c08 commit 4d9459e

File tree

4 files changed

+90
-0
lines changed

4 files changed

+90
-0
lines changed
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
### Your checklist for this pull request
2+
🚨Please review the [guidelines for contributing](../CONTRIBUTING.md) to this repository.
3+
4+
- [ ] Make sure you are requesting to **pull a topic/feature/bugfix branch** (right side). Don't request your master!
5+
- [ ] Make sure you have 100% test coverage
6+
- [ ] Check the commit's or even all commits' message styles matches our requested structure.
7+
- [ ] Check your code linting
8+
9+
### Description
10+
Please describe your pull request.
11+
12+
💔Thank you!

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: 🐞 Bug Report
2+
description: Tell us about something that's not working the way we (probably) intend.
3+
body:
4+
- type: dropdown
5+
id: os
6+
attributes:
7+
label: OS
8+
options:
9+
- osx
10+
- linux
11+
- windows
12+
validations:
13+
required: false
14+
- type: input
15+
id: version
16+
attributes:
17+
label: Version
18+
description: Which Library version?
19+
placeholder: ex. 0.4.3
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: repro
24+
attributes:
25+
label: Steps to Reproduce
26+
description: How can we see what you're seeing? Specific is terrific.
27+
placeholder: |-
28+
1. What
29+
2. you
30+
3. did.
31+
32+
Extra points for also including the output of `pip freeze --all`.
33+
validations:
34+
required: false
35+
- type: textarea
36+
id: logs
37+
attributes:
38+
label: Result logs
39+
description: Logs? Screenshots? Yes, please.
40+
validations:
41+
required: true
42+
- type: markdown
43+
attributes:
44+
value: |-
45+
## Thanks 🙏
46+
validations:
47+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Question or Problem
4+
about: Ask a question or ask about a problem in GitHub Discussions.
5+
url: https://t.me/fastcrawler

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: 💡 Feature Request
2+
description: Create a feature request for fastcrawler.
3+
labels: 'enhancement'
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: Thanks for taking the time to file a feature request! Please fill out this form as completely as possible.
8+
- type: textarea
9+
id: usecase
10+
attributes:
11+
label: Use Case Statement
12+
description: A clear and concise description of what you want and what your use case is.
13+
placeholder: Well, I wanted to do ...., but it is not implemented
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: expected
18+
attributes:
19+
label: Solution Brainstorm
20+
description: We know you have bright ideas to share ... share away, friend.
21+
placeholder: My idea is ....
22+
validations:
23+
required: false
24+
- type: markdown
25+
attributes:
26+
value: Thanks 🙏

0 commit comments

Comments
 (0)