Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Added Github Workflow #160

Merged
merged 3 commits into from
Jan 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: ​🐞 Bug
description: Report an issue to help us improve the project.
title: "[BUG] <write a small description here>"
labels: ["bug", "goal: fix"]
body:
- type: textarea
attributes:
label: Description
description: A brief description of the issue or bug you are facing, also include what you tried and what didn't work.
validations:
required: false
- type: textarea
attributes:
label: Screenshots
description: Please add screenshots if applicable
validations:
required: false
- type: textarea
attributes:
label: Any additional information?
description: Any additional information or Is there anything we should know about this bug?
validations:
required: false
- type: dropdown
id: browsers
attributes:
label: What browser are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "Checklist"
options:
- label: "I have starred the repository"
required: true

- label: "I have checked the existing issues"
required: true

- label: "I have read the discussion tab thoroughly and got the project idea"
required: true

- label: "I am willing to work on this issue (optional)"
required: false




77 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
name: Documentation Issue
about: Report an issue with the project documentation
title: "[Documentation] "

---

body:
- type: markdown
attributes:
value: |
<!--
Please follow the guidelines below to report documentation issues effectively.
-->

### Issue Summary

**Description:**
A clear and concise description of the problem with the documentation or the improvement you'd like to suggest.

**Severity:**
[ ] Low
[ ] Medium
[ ] High
[ ] Critical

**Affected Documentation Section:**
Specify the relevant section(s) or page(s) of the documentation where you encountered the issue.

### Expected Documentation

**Describe the expected content:**
If applicable, describe how you expected the documentation to be or provide examples of how it could be improved.

**Proposed Solution:**
Share your ideas for improving the documentation or propose a solution if you have one.

### Reproduction Steps

**Steps to Reproduce:**
If the issue is related to inaccuracies or unclear instructions, provide the steps to reproduce the problem.

**Screenshots or Code Snippets:**
Attach any relevant screenshots or code snippets that illustrate the problem.

### Environment Information

**Your Environment:**
- OS: [e.g., Windows, macOS, Linux]
- Browser: [e.g., Chrome, Firefox, Safari]
- Version: [e.g., 1.0.0]

**Additional Context:**
Add any other context or details that might be helpful for understanding the issue.

### Related Documentation URLs

**Links:**
If relevant, provide any specific URLs or links to the documentation in question.

### Contributor Checklist

Please make sure that you have considered the following before submitting this documentation issue:

- [ ] I have checked the project's existing documentation issues to ensure there are no duplicates.
- [ ] I have reviewed the project's CONTRIBUTING guidelines.
- [ ] I understand that submitting a documentation issue does not guarantee immediate updates.

### Additional Notes

**Notes:**
Add any other notes or comments related to this documentation issue.

<!--
Thank you for contributing to our project's documentation!
Please make sure to review our CONTRIBUTING guidelines before submitting your issue.
-->
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature Request 💡
description: Have any new idea or new feature ? Please suggest!
title: "[Feature] <write a small description here>"
labels: ["enhancement", "goal: addition"]
body:
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of any alternative solution or features you've considered.
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Please add screenshots if applicable
validations:
required: false
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "Checklist"
options:
- label: "I have starred the repository"
required: true

- label: "I have checked the existing issues"
required: true

- label: "I have read the discussion tab thoroughly and got the project idea "
required: true

- label: "I am willing to work on this issue (optional)"
required: false


38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/styles.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Style Changing Request
description: Suggest a style designs
title: '[style]: '
labels: ['enhancement']

---

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this template!
- type: textarea
id: style-idea
attributes:
label: What's the style idea?
placeholder: Add descriptions
value: 'We need to improve '
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Add screenshots
description: Add screenshots to see the demo
placeholder: Add screenshots
value: 'Add screenshots'
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct
required: true

- label: I want to work on this issue
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!-- Pull Request Template -->

## Related Issue

Closes #issue_number

<!-- If there is no issue number, the PR will not be merged. Therefore, please ensure that the issue number is added -->

## Description

<!-- Write a brief description of the changes made in the PR. Explain the problem being addressed, or any relevant
information. -->

## Screenshots (if applicable)

| Original | Updated |
| :-----------------: | :----------------: |
| original screenshot | updated screenshot |

## Checklist

<!-- [x] - To mark checked, put 'x' in place of ' '(space) -->
<!-- [ ] - Keep unchecked using ' '(space) -->

- [ ] My code adheres to the established style guidelines of the project.
- [ ] I have included comments in areas that may be difficult to understand.
- [ ] My changes have not introduced any new warnings.
- [ ] I have conducted a self-review of my code.
16 changes: 16 additions & 0 deletions .github/workflows/greetings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Greetings

on: [pull_request, issues]

jobs:
greeting:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- uses: actions/first-interaction@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
issue-message: 'Hey, @${{ github.actor }} welcome to Top_Secrets repository.🎊 Thank you so much for taking the time to point this out.🙌'
pr-message: 'Hey, @${{ github.actor }} welcome to Top_Secrets repository.🎊 Thank you so much for taking the effort to make our project better! 🙌 Keep making such awesome contributions!'