Skip to content

Commit

Permalink
💄Add Github Template (#35)
Browse files Browse the repository at this point in the history
* complete documentation

* ✨ add template

* 🚸 improve gh templates

* ✏️ fix typo errors in gh templates

---------

Co-authored-by: ManiMozaffar <[email protected]>
  • Loading branch information
vahidtwo and ManiMozaffar authored Jul 16, 2023
1 parent d8b9c08 commit 4d9459e
Show file tree
Hide file tree
Showing 4 changed files with 90 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/PULL_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
### Your checklist for this pull request
🚨Please review the [guidelines for contributing](../CONTRIBUTING.md) to this repository.

- [ ] Make sure you are requesting to **pull a topic/feature/bugfix branch** (right side). Don't request your master!
- [ ] Make sure you have 100% test coverage
- [ ] Check the commit's or even all commits' message styles matches our requested structure.
- [ ] Check your code linting

### Description
Please describe your pull request.

💔Thank you!
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: 🐞 Bug Report
description: Tell us about something that's not working the way we (probably) intend.
body:
- type: dropdown
id: os
attributes:
label: OS
options:
- osx
- linux
- windows
validations:
required: false
- type: input
id: version
attributes:
label: Version
description: Which Library version?
placeholder: ex. 0.4.3
validations:
required: true
- type: textarea
id: repro
attributes:
label: Steps to Reproduce
description: How can we see what you're seeing? Specific is terrific.
placeholder: |-
1. What
2. you
3. did.
Extra points for also including the output of `pip freeze --all`.
validations:
required: false
- type: textarea
id: logs
attributes:
label: Result logs
description: Logs? Screenshots? Yes, please.
validations:
required: true
- type: markdown
attributes:
value: |-
## Thanks 🙏
validations:
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Question or Problem
about: Ask a question or ask about a problem in GitHub Discussions.
url: https://t.me/fastcrawler
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: 💡 Feature Request
description: Create a feature request for fastcrawler.
labels: 'enhancement'
body:
- type: markdown
attributes:
value: Thanks for taking the time to file a feature request! Please fill out this form as completely as possible.
- type: textarea
id: usecase
attributes:
label: Use Case Statement
description: A clear and concise description of what you want and what your use case is.
placeholder: Well, I wanted to do ...., but it is not implemented
validations:
required: true
- type: textarea
id: expected
attributes:
label: Solution Brainstorm
description: We know you have bright ideas to share ... share away, friend.
placeholder: My idea is ....
validations:
required: false
- type: markdown
attributes:
value: Thanks 🙏

0 comments on commit 4d9459e

Please sign in to comment.