Skip to content

Commit 2480a97

Browse files
author
Harshit Kr Vishwakarma
committed
add readme
1 parent daeb70a commit 2480a97

File tree

4 files changed

+156
-0
lines changed

4 files changed

+156
-0
lines changed

‎README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Levi
2+
3+
<div style="display:flex; align-items: center; justify-content: center; flex-direction:column;">
4+
<img src="https://i.imgur.com/BJZKLDR.jpg" width="90px" style="text-align: center;">
5+
<div>
6+
<img src="https://img.shields.io/discord/808991875934847026">
7+
</div>
8+
</div>
9+
10+
Levi is a Discord bot equipped with OpenAI APIs like ChatGPT to provide you with assistance right within your own server using [discord.js](https://discord.js.org/#/).
11+
12+
## Add to Server
13+
14+
[Add Levi to your server](https://discord.com/api/oauth2/authorize?client_id=1123810664100671578&permissions=2048&scope=applications.commands%20bot)
15+
16+
## Commands
17+
18+
### Fun Commands ✨
19+
20+
- `/sarcasm` - Get a random sarcastic comment from Chandler Bing.
21+
22+
### Core Commands 📜
23+
24+
- `/help` - Lists all available commands.
25+
26+
### Mod Commands 🛡️
27+
28+
- `/clear` - Clears a specified number of messages.
29+
30+
### OpenAI Commands 🤖
31+
32+
- `/gpt` - Ask GPT any question (powered by [OpenAI](https://beta.openai.com/overview)).
33+
- `/instruct-gpt` - Instruct GPT regarding a specific task to get more accurate results.
34+
35+
## Contributing
36+
37+
Read the [contribution guidelines](docs/contributing/contributing.md) for detailed information on how to contribute to Levi.

‎docs/code-of-conduct.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Code of Conduct
2+
3+
### Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
### Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
### Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
### Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
### Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
### Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

‎docs/contributing/contributing.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing
2+
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.
3+
4+
Please note we have a code of conduct, please follow it in all your interactions with the project.
5+
6+
## Getting started
7+
8+
Check to see what [types of contributions](./types-of-contribution.md) we accept before making changes. Some of them don't even require writing a single line of code ✨.
9+
10+
11+
### Issues
12+
13+
#### Create a new issue
14+
15+
If you spot a problem with, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue.
16+
17+
#### Solve an issue
18+
19+
Scan through our [existing issues](https://github.com/github/docs/issues) to find one that interests you. You can narrow down the search using `labels` as filters. See [Labels](/contributing/how-to-use-labels.md) for more information.
20+
21+
### Pull Request
22+
23+
When you're finished with the changes, create a pull request, also known as a PR.
24+
25+
- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
26+
- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
27+
Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information.
28+
- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
29+
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
30+
- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.
31+

‎docs/contributing/types-of-contribution.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Types of contributions
2+
3+
### Discussions
4+
Discussions are where we have conversations.
5+
6+
If you'd like help troubleshooting a docs PR you're working on, have a great new idea, or want to share something amazing you've learned in our docs, join us in [discussions](https://github.com/HarshitRV/FileShare/discussions/5).
7+
8+
### Issues
9+
[Issues](https://docs.github.com/en/github/managing-your-work-on-github/about-issues) are used to track tasks that contributors can help with.
10+
11+
If you've found something in the content or the website that should be updated, search open issues to see if someone else has reported the same thing. If it's something new, open an issue. We'll use the issue to have a conversation about the problem you want to fix.
12+
13+
### Pull requests
14+
A [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) is a way to suggest changes in our repository.

0 commit comments

Comments
 (0)