Skip to content

Commit

Permalink
Improved yml Issue Templates and config added
Browse files Browse the repository at this point in the history
  • Loading branch information
vihar-s1 committed Oct 23, 2023
1 parent 028c44c commit f637b6c
Show file tree
Hide file tree
Showing 8 changed files with 176 additions and 85 deletions.
39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Bug Report🐛
description: File a bug report
title: "[BUG]: "
labels: ["bug"]
# projects: []
# assignees: ["vihar-s1"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!🤗
- type: textarea
id: bug-description
attributes:
label: Brief Bug Description
description: Tell us about what happened? |
Use Screenshots where necessary to assist explanation.
placeholder: Tell us what you see!
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Brief Idea about Expected Behavior
description: Tell us about what did you expect to happen? |
Use Screenshots where necessary to assist explanation.
placeholder: Tell us what you want to see!
validations:
required: true

- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell

- type: checkboxes
id: checks
attributes:
label: Check-List
description: Please make sure to check the following milestones before submitting the bug report!
options:
- label: I have checked that a similar kind of bug report does not already exist!
required: true
- label: I can reproduce the issue consistently.
required: true
- label: I have read the [Contributing Guidelines](https://github.com/vihar-s1/Desktop-Assistant/blob/main/CONTRIBUTING.md)
required: true
- label: I want to work on solving the bug !
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Matrix Communication Space
url: https://matrix.to/#/#desktop-assistant-github-project:matrix.org
about: Join this Space to have discussions with other developers contributing
- name: Discussion Page
url: https://github.com/vihar-s1/Desktop-Assistant/discussions
about: Github Discussion Page for the Repository
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Documentation Issue📋
description: Improvements or addition to documentations
title: "[DOC]: "
labels: ["documentation"]
# projects: []
# assignees: ["vihar-s1"]
body:
- type: markdown
attributes:
value: |
A good documentation is always helpful for first time users to begin with the project or users returing after a break!
Help us maintain a good standard of documentation for the project.
- type: textarea
id: description
attributes:
label: Suggestions
description: |
Tell us about the issues or improvements you think are required !
Use Screenshots where necessary to assist explanation.
placeholder: Tell us what you imagined!
validations:
required: true

- type: dropdown
id: suggestion-type
attributes:
label: Type of Suggestion
description: Is this suggestion a documentation bug or addition?
options:
- New Information
- Documentation Bug
default: 0
validations:
required: true

- type: checkboxes
id: checks
attributes:
label: Check-List
description: Please make sure to check the following milestones before submitting the bug report!
options:
- label: I have checked that a similar kind of feature request does not already exist!
required: true
- label: I have read the [Contributing Guidelines](https://github.com/vihar-s1/Desktop-Assistant/blob/main/CONTRIBUTING.md)
required: true
- label: I want to work on this documentation update !
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Feature Request✨
description: Request a new feature or enhancement
title: "[FEAT]: "
labels: ["enhancement"]
# projects: []
# assignees: ["vihar-s1"]
body:
- type: markdown
attributes:
value: |
Thank you for helping us improve the project with additional features and improvements!
- type: textarea
id: description
attributes:
label: Feature Idea
description: |
Tell us about this new feature you thought of !
Use Screenshots where necessary to assist explanation.
placeholder: Tell us what you imagined!
validations:
required: true

- type: textarea
id: solution
attributes:
label: Solution Approach
description: Please tell us about any approach you have thought of about the feature !

- type: textarea
id: additional-info
attributes:
label: Additional Information
description: Any additional Information You would like to give about this feature,

- type: checkboxes
id: checks
attributes:
label: Check-List
description: Please make sure to check the following milestones before submitting the bug report!
options:
- label: I have checked that a similar kind of feature request does not already exist!
required: true
- label: I have read the [Contributing Guidelines](https://github.com/vihar-s1/Desktop-Assistant/blob/main/CONTRIBUTING.md)
required: true
- label: I want to work on this feature-request ! (Solution Approach Required)
23 changes: 12 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,24 @@ Welcome to the open-source Voice-Assisted Desktop Assistant project! Contributio

2. **Make Changes:** Work on what interests you - add new features, fix bugs, or improve documentation on a **_separate branch_**. It's your playground!

```bash
git checkout -b <new-branch-name>
```
```bash
git checkout -b <new-branch-name>
```

3. **Commit Changes:** Use clear and simple commit messages. For example:
- "Added a weather command"
- "Fixed voice recognition bug"

```bash
git commit -m "<mandatory commit message here>" -m "<optional commit description here>"
```
- "Added a weather command"
- "Fixed voice recognition bug"

```bash
git commit -m "<mandatory commit message here>" -m "<optional commit description here>"
```

4. **Push to Your Fork:** Send your changes back to your forked repository.

```bash
git push origin <branch-name>
```
```bash
git push origin <branch-name>
```

5. **Create a Pull Request (PR):** Open a PR to the main project repository. Describe your changes briefly and why they're awesome.
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,23 +52,23 @@ A simple voice-assisted desktop assistant made in Python. The assistant will hav

1. Download and extract the zip file or clone the repository using the following command.

```bash
git clone https://github.com/vihar-s1/Desktop-Assistant
```
```bash
git clone https://github.com/vihar-s1/Desktop-Assistant
```

2. In the project root directory run following commands to create a virtual environment, activate it, and install the python module dependencies.

```bash
python -m venv .venv
source .venv/Scripts/activate
pip install -r requirements.txt
```
```bash
python -m venv .venv
source .venv/Scripts/activate
pip install -r requirements.txt
```

3. Once installed, simply run the `Assistant.py` file to start using the Assistant.

```bash
python Assistant.py
```
```bash
python Assistant.py
```

## 🤝 Contributing

Expand Down

0 comments on commit f637b6c

Please sign in to comment.