Skip to content

Commit 4829ab3

Browse files
VoxDroidVoxDroid
committed
docs: upload documentation files and upload issue templates
1 parent aac9648 commit 4829ab3

10 files changed

Lines changed: 525 additions & 0 deletions

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: Bug Report
2+
description: Report a bug or issue with Text-Extractor
3+
labels: ["bug", "triage"]
4+
assignees: ["VoxDroid"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please follow our [Contributing Guidelines](https://github.com/VoxDroid/Text-Extractor/blob/main/CONTRIBUTING.md). Do not post unverified links or promotional content, as they will be considered spam and may lead to restrictions.
10+
# Edit: Replace https://github.com/VoxDroid/Text-Extractor/blob/main/CONTRIBUTING.md with the path to your contributing guidelines (e.g., https://github.com/VoxDroid/Text-Extractor/blob/main/CONTRIBUTING.md).
11+
- type: checkboxes
12+
id: guidelines
13+
attributes:
14+
label: Guidelines
15+
description: Confirm that you have read and agree to follow our guidelines.
16+
options:
17+
- label: I have read the [Contributing Guidelines](https://github.com/VoxDroid/Text-Extractor/blob/main/CONTRIBUTING.md) and agree to follow them.
18+
required: true
19+
- type: textarea
20+
id: description
21+
attributes:
22+
label: Description
23+
description: A clear and concise description of the bug.
24+
placeholder: Describe what happened...
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: steps
29+
attributes:
30+
label: Steps to Reproduce
31+
description: Provide detailed steps to reproduce the issue.
32+
placeholder: |
33+
1. Step 1
34+
2. Step 2
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: expected-behavior
39+
attributes:
40+
label: Expected Behavior
41+
description: What you expected to happen.
42+
placeholder: Describe what should have happened...
43+
validations:
44+
required: true
45+
- type: textarea
46+
id: actual-behavior
47+
attributes:
48+
label: Actual Behavior
49+
description: What actually happened.
50+
placeholder: Describe what went wrong...
51+
validations:
52+
required: true
53+
- type: dropdown
54+
id: environment
55+
attributes:
56+
label: Environment
57+
description: What environment are you using?
58+
options:
59+
- Windows
60+
- macOS
61+
- Linux
62+
- Other
63+
default: 0
64+
validations:
65+
required: true
66+
- type: input
67+
id: version
68+
attributes:
69+
label: Project Version
70+
description: What version of Text-Extractor are you using?
71+
placeholder: e.g., v1.0.0
72+
validations:
73+
required: false
74+
- type: textarea
75+
id: screenshots
76+
attributes:
77+
label: Screenshots or Logs
78+
description: If applicable, attach screenshots or logs to help explain the issue.
79+
placeholder: Drag and drop files here or paste logs...
80+
validations:
81+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: General Discussion
4+
url: https://github.com/VoxDroid/Text-Extractor/discussions
5+
about: For ideas, questions, or feedback, please use the Discussions tab.
6+
- name: Support Resources
7+
url: https://github.com/VoxDroid/Text-Extractor/blob/main/SUPPORT.md
8+
about: Check the Support page for common issues and solutions.
9+
- name: Security Contact
10+
url: mailto:izeno.contact@gmail.com
11+
about: For sensitive security issues, please email us directly instead of opening a public issue.

‎.github/ISSUE_TEMPLATE/documentation_issue.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Documentation Issue Template
2+
name: Documentation Issue
3+
description: Report errors or suggest improvements to Text-Extractor documentation
4+
labels: ["documentation", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please follow our [Contributing Guidelines](https://github.com/VoxDroid/Text-Extractor/blob/main/CONTRIBUTING.md). Do not post unverified links or promotional content, as they will be considered spam and may lead to restrictions.
10+
# Edit: Replace https://github.com/VoxDroid/Text-Extractor/blob/main/CONTRIBUTING.md with your contributing guidelines path.
11+
- type: checkboxes
12+
id: guidelines
13+
attributes:
14+
label: Guidelines
15+
description: Confirm that you have read and agree to follow our guidelines.
16+
options:
17+
- label: I have read the [Contributing Guidelines](https://github.com/VoxDroid/Text-Extractor/blob/main/CONTRIBUTING.md) and agree to follow them.
18+
required: true
19+
- type: textarea
20+
id: doc-issue
21+
attributes:
22+
label: Documentation Issue
23+
description: Describe the issue or improvement needed in the documentation.
24+
placeholder: e.g., Missing steps in README, unclear instructions...
25+
validations:
26+
required: true
27+
- type: input
28+
id: doc-location
29+
attributes:
30+
label: Documentation Location
31+
description: Where is the issue located?
32+
placeholder: e.g., README.md, docs/index.md
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: suggestion
37+
attributes:
38+
label: Suggested Fix
39+
description: If you have a suggestion for how to fix this, please describe it.
40+
placeholder: e.g., Add a section on installation...
41+
validations:
42+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement for Text-Extractor
3+
labels: ["enhancement", "triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please follow our [Contributing Guidelines](https://github.com/VoxDroid/Text-Extractor/blob/main/CONTRIBUTING.md). Do not post unverified links or promotional content, as they will be considered spam and may lead to restrictions.
9+
# Edit: Replace https://github.com/VoxDroid/Text-Extractor/blob/main/CONTRIBUTING.md with your contributing guidelines path.
10+
- type: checkboxes
11+
id: guidelines
12+
attributes:
13+
label: Guidelines
14+
description: Confirm that you have read and agree to follow our guidelines.
15+
options:
16+
- label: I have read the [Contributing Guidelines](https://github.com/VoxDroid/Text-Extractor/blob/main/CONTRIBUTING.md) and agree to follow them.
17+
required: true
18+
- type: textarea
19+
id: feature-description
20+
attributes:
21+
label: Feature Description
22+
description: Describe the feature and why it would be useful.
23+
placeholder: Explain the feature...
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: use-case
28+
attributes:
29+
label: Use Case
30+
description: Provide examples of how this feature would be used.
31+
placeholder: Describe scenarios where this feature would help...
32+
validations:
33+
required: false
34+
- type: textarea
35+
id: challenges
36+
attributes:
37+
label: Potential Challenges
38+
description: Any challenges or considerations for implementing this feature?
39+
placeholder: Note any technical or design challenges...
40+
validations:
41+
required: false
42+
- type: dropdown
43+
id: feature-type
44+
attributes:
45+
label: Feature Type
46+
description: What type of feature is this?
47+
options:
48+
- Functionality
49+
- User Interface
50+
- Performance
51+
- Other
52+
default: 0
53+
validations:
54+
required: true

‎.github/ISSUE_TEMPLATE/security_report.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Security Report
2+
description: Report a security vulnerability in Text-Extractor
3+
labels: ["security", "triage"]
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Please follow our [Contributing Guidelines](https://github.com/VoxDroid/Text-Extractor/blob/main/CONTRIBUTING.md). Do not post unverified links or promotional content, as they will be considered spam and may lead to restrictions.
8+
**Note**: For security issues, please consider emailing izeno.contact@gmail.com directly to avoid public disclosure. Use this template only if you are comfortable sharing details publicly.
9+
- type: checkboxes
10+
id: guidelines
11+
attributes:
12+
label: Guidelines
13+
description: Confirm that you have read and agree to follow our guidelines.
14+
options:
15+
- label: I have read the [Contributing Guidelines](https://github.com/VoxDroid/Text-Extractor/blob/main/CONTRIBUTING.md) and agree to follow them.
16+
required: true
17+
- type: textarea
18+
id: vulnerability
19+
attributes:
20+
label: Vulnerability Description
21+
description: Describe the security vulnerability in detail.
22+
placeholder: e.g., Potential data leak in API...
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: impact
27+
attributes:
28+
label: Impact
29+
description: What is the potential impact of this vulnerability?
30+
placeholder: e.g., Could allow unauthorized access...
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: reproduction
35+
attributes:
36+
label: Steps to Reproduce
37+
description: Provide steps to reproduce the vulnerability, if known.
38+
placeholder: |
39+
1. Step 1
40+
2. Step 2
41+
validations:
42+
required: false
43+
- type: textarea
44+
id: mitigation
45+
attributes:
46+
label: Suggested Mitigation
47+
description: If you have ideas for mitigating this issue, please describe them.
48+
placeholder: e.g., Add input validation...
49+
validations:
50+
required: false

‎.github/ISSUE_TEMPLATE/support_question.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Support Question
2+
description: Ask a question or seek help with using Text-Extractor
3+
labels: ["question", "triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please follow our [Contributing Guidelines](https://github.com/VoxDroid/Text-Extractor/blob/main/CONTRIBUTING.md). Do not post unverified links or promotional content, as they will be considered spam and may lead to restrictions.
9+
For general help, consider checking the [Support page](https://github.com/VoxDroid/Text-Extractor/blob/main/SUPPORT.md) or starting a thread in [Discussions](https://github.com/VoxDroid/Text-Extractor/discussions).
10+
- type: checkboxes
11+
id: guidelines
12+
attributes:
13+
label: Guidelines
14+
description: Confirm that you have read and agree to follow our guidelines.
15+
options:
16+
- label: I have read the [Contributing Guidelines](https://github.com/VoxDroid/Text-Extractor/blob/main/CONTRIBUTING.md) and agree to follow them.
17+
required: true
18+
- type: textarea
19+
id: question
20+
attributes:
21+
label: Your Question
22+
description: Describe your question or issue in detail.
23+
placeholder: Ask away...
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: context
28+
attributes:
29+
label: Context
30+
description: Provide any relevant details about your setup or what you’ve tried.
31+
placeholder: |
32+
- Environment: [e.g., Windows 11]
33+
- Version: [e.g., v1.0.0]
34+
- What you’ve tried: [e.g., checked documentation]
35+
validations:
36+
required: false
37+
- type: dropdown
38+
id: category
39+
attributes:
40+
label: Question Category
41+
description: What is this question about?
42+
options:
43+
- Installation
44+
- Usage
45+
- Configuration
46+
- Other
47+
default: 0
48+
validations:
49+
required: true

‎CODE_OF_CONDUCT.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers of **Text Extractor** pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
- Using welcoming and inclusive language.
11+
- Being respectful of differing viewpoints and experiences.
12+
- Gracefully accepting constructive criticism.
13+
- Focusing on what is best for the community.
14+
- Showing empathy towards other community members.
15+
16+
Examples of unacceptable behavior include:
17+
- The use of sexualized language or imagery and unwelcome sexual attention or advances.
18+
- Trolling, insulting/derogatory comments, and personal or political attacks.
19+
- Public or private harassment.
20+
- Publishing others' private information, such as a physical or electronic address, without explicit permission.
21+
- Other conduct which could reasonably be considered inappropriate in a professional setting.
22+
23+
## Our Responsibilities
24+
25+
Project maintainers (@VoxDroid and collaborators) are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
26+
27+
Maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
28+
29+
## Scope
30+
31+
This Code of Conduct applies both within project spaces (e.g., GitHub repository, issues, pull requests) and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
32+
33+
## Enforcement
34+
35+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainer at izeno.contact@gmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident.
36+
37+
Further details of specific enforcement policies may be posted separately.
38+
39+
## Attribution
40+
41+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
42+
43+
For answers to common questions about this Code of Conduct, see https://www.contributor-covenant.org/faq.
44+
45+
---
46+
47+
**Developed by VoxDroid**
48+
[GitHub](https://github.com/VoxDroid) | [Ko-fi](https://ko-fi.com/izeno)
49+
50+
---

0 commit comments

Comments
 (0)