Skip to content

Commit

Permalink
Add markdown files
Browse files Browse the repository at this point in the history
  • Loading branch information
Delemangi committed Dec 16, 2023
1 parent 45b3bd0 commit 8b9f275
Show file tree
Hide file tree
Showing 6 changed files with 90 additions and 8 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Contributing
# Contributing

[fork]: /fork
[pr]: /compare
Expand All @@ -22,7 +22,7 @@ We'd also love PRs. If you're thinking of a large PR, we advise opening up an is
3. Install the Git pre-commit hooks: `npm run prepare`.
4. Create a new branch: `git checkout -b <name>`.
5. Make your changes.
6. Format your code and check for issues: `npm run lint:fix`.
6. Format your code and check for issues: `npm run format`.
7. Push to your fork and [submit a pull request][pr].
8. Pat your self on the back and wait for your pull request to be reviewed and merged.

Expand Down
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Bug Report
description: File a bug report
labels:
- bug
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Describe the issue here.
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Other context
description: Any other context, screenshots, or similar that will help us.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Feature request
description: Request a new feature
labels:
- enhancement
body:
- type: textarea
id: description
attributes:
label: Feature
description: A clear and concise description of what the problem is, or what feature you want to be implemented.
placeholder: I'm always frustrated when..., Discord has recently released..., A good addition would be...
validations:
required: true
- type: textarea
id: solution
attributes:
label: Ideal solution or implementation
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Other context
description: Any other context, screenshots, or similar that will help us.
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Question
description: Ask a question
labels:
- question
body:
- type: textarea
id: issue-description
attributes:
label: What is your question?
description: Please try to be as clear and concise as possible.
validations:
required: true
23 changes: 17 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
## Changes
# **Name**

<!-- briefly list and describe all the changes -->
<!-- This PR fixes #NUMBER_OF_THE_ISSUE, and fixes #NUMBER_OF_THE_ISSUE -->

## Status
## **Description**

- [ ] The changes have been tested, or there are no code changes.
- [ ] The changes include updated typings, if needed.
- [ ] The changes follow the code style of the project.
<!--
Please include a summary of the change and/or which issue is fixed.
List any dependencies required for this change, if there are any.
-->

### **Additional**

<!-- Add any other context or additional information about the pull request.-->

<!--
If it fixes any current issue please let us know this way:
Uncomment the comment above "description", then add your number of issues after the "#".
Example: # **This PR fixes #NUMBER_OF_THE_ISSUE**
-->
11 changes: 11 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# **Reporting Security Issues**

The project's team and community take security issues.

We appreciate your efforts to disclose your findings responsibly and will make every effort to acknowledge your contributions.

To report a security issue, go to the project's issues and create a new issue using the ⚠️ Security Report 'issue template'.

Read the instructions of this issue template carefully, and if your report could leak data or might expose how to gain access to a restricted area or break the system, please send a mail to [milev.stefan@gmail.com](mailto:milev.stefan@gmail.com).

We'll endeavour to respond quickly and keep you updated throughout the process.

0 comments on commit 8b9f275

Please sign in to comment.