Skip to content

Commit

Permalink
v3.0 Released
Browse files Browse the repository at this point in the history
  • Loading branch information
NotReallyShikhar committed Mar 5, 2022
1 parent 6755835 commit f5ca844
Show file tree
Hide file tree
Showing 221 changed files with 14,233 additions and 11,313 deletions.
12 changes: 6 additions & 6 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.env
*.log
.git/
.idea/
README.md
downloads/
Yukkilogs.txt
.DS_Store
*.session
raw_files/
.gitignore
cache/
downloads/
__pycache__/
*.session-journal
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@NotReallyShikhar
45 changes: 45 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers 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.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. 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. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainer using any of the [private contact addresses](https://github.com/TeamYukki/yukkimusicbot#support). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>

For answers to common questions about this code of conduct, see <https://www.contributor-covenant.org/faq>
44 changes: 44 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.

## Development environment setup

To set up a development environment, please follow these steps:

1. Clone the repo

```sh
git clone https://github.com/TeamYukki/YukkiMusicBot
```

2. Use sensible commit messages
> If your PR fixes a separate issue number, include it in the commit message

3. Use a sensible number of commit messages as well
> Your PR should not have 100s of commits

## Issues and feature requests

You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by [submitting an issue on GitHub](https://github.com/TeamYukki/YukkiMusicBot/issues). Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!

Please try to create bug reports that are:

- _Reproducible._ Include steps to reproduce the problem.
- _Specific._ Include as much detail as possible: which version, what environment, etc.
- _Unique._ Do not duplicate existing opened issues.
- _Scoped to a Single Bug._ One bug per report.

**Even better: Submit a pull request with a fix or new feature!**

### How to submit a Pull Request

1. Search our repository for open or closed
[Pull Requests](https://github.com/TeamYukki/YukkiMusicBot/pulls)
that relate to your submission. You don't want to duplicate effort.
2. Fork the project
3. Create your feature branch (`git checkout -b feat/amazing_feature`)
4. Commit your changes (`git commit -m 'feat: add amazing_feature'`) YukkiMusicBot uses [conventional commits](https://www.conventionalcommits.org), so please follow the specification in your commit messages.
5. Push to the branch (`git push origin feat/amazing_feature`)
6. [Open a Pull Request](https://github.com/TeamYukki/YukkiMusicBot/compare?expand=1)
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: 'TeamYukki'
---
> Provide a general summary of the issue in the Title above.
## Expected behavior
* Tell us what should happen.

## Current behavior
* Tell us what happens instead of the expected behavior.

## Screenshot [ Optional ]
* Make a screenshot to help us understand the context more clearly.

## Possible reasons and solutions [ Optional ]
* Suggest a fix/reason for the bug.

## Context
* How has this issue affected you? How it appeared? What are you trying to accomplish?
* Providing context helps us come up with a solution that is most useful in the real world.

## Custom values [Optional]
* Modified any values? Added any new commands? Tweaked anything?

## Your environment
* Include as many relevant details about your environment.

## Stack trace
* Include stack trace of the logs/console.

## Checklist
> Go over all the following points, and put an `x` in all the boxes that apply.
- [ ] I searched the [current issues](https://github.com/TeamYukki/YukkiMusicBot/issues) and the issue is not known.
- [ ] I searched on Google, Steam, YouTube, Reddit and there's no fix.
- [ ] I am mostly sure that the problem is related to the project and isn't my fault.
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/CODEBASE_IMPROVEMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: Codebase improvement
about: Provide your feedback for the existing codebase. Suggest a better solution for algorithms, development tools, etc.
title: "dev: "
labels: "enhancement"
assignees: ""
---
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Feature Request
about: Suggest an idea for this project
title: "feat: "
labels: "enhancement"
assignees: ""
---

# Feature Request

**Describe the Feature Request**

<!-- A clear and concise description of what the feature request is. Please include if your feature request is related to a problem. -->

**Describe Preferred Solution**

<!-- A clear and concise description of what you want to happen. -->

**Describe Alternatives**

<!-- A clear and concise description of any alternative solutions or features you've considered. -->

**Related Code**

<!-- If you are able to illustrate the bug or feature request with an example, please provide it here. -->

**Additional Context**

<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to add, use case, Stack Overflow links, forum links, screenshots, OS if applicable, etc. -->

**If the feature request is approved, would you be willing to submit a PR?**
_(Help can be provided if you need assistance submitting a PR)_

- [ ] Yes
- [ ] No
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Support Question
about: Question on how to use this project
title: "support: "
labels: "question"
assignees: ""
---

# Support Question
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: true
contact_links:
- name: Yukki Support
url: https://t.me/YukkiSupport
about: Direct chat on non-inquiries subjects.
- name: Documentation
url: https://Yukki.tech/
about: Documentation for getting started with bot.
35 changes: 35 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@

## Pull Request type
> Please try to limit your pull request to one type; submit multiple pull requests if needed.
Please check the type of change your PR introduces:

- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, renaming)
- [ ] Refactoring (no functional changes, no API changes)
- [ ] Build-related changes
- [ ] Documentation content changes
- [ ] Other (please describe):

## What is the current behavior?
> Please describe the current behavior that you are modifying, or link to a relevant issue.
Issue Number: N/A

## What is the new behavior?
> Please describe the behavior or changes that are being added by this PR.
-
-
-

## Does this introduce a breaking change?

- [ ] Yes
- [ ] No

> If this does introduce a breaking change, please describe the impact and migration path for existing applications below.
## Other information
> Any other information that is important to this PR, such as screenshots of how the component looks before and after the change.
Loading

0 comments on commit f5ca844

Please sign in to comment.