Skip to content

Commit 8f64e3e

Browse files
authored
✨ TWEAK: add few important docs
1 parent 24e6e67 commit 8f64e3e

File tree

4 files changed

+125
-5
lines changed

4 files changed

+125
-5
lines changed

README.md

+18-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Support Fren (thirdweb support)
1+
# Thread-based Support Bot (thirdweb support)
22

33
Dedicated thread-based support Discord bot for the thirdweb community.
44

@@ -17,7 +17,11 @@ Dedicated thread-based support Discord bot for the thirdweb community.
1717
"emoji_assign": "👀",
1818
"emoji_close": "",
1919
"command_prefix": "!",
20-
"auto_archive_duration": 10080
20+
"auto_archive_duration": 10080,
21+
"timezone": "America/Los_Angeles",
22+
"datasheet_init": "init",
23+
"datasheet_response": "response",
24+
"datasheet_resolve": "resolve"
2125
}
2226
```
2327

@@ -27,12 +31,19 @@ Dedicated thread-based support Discord bot for the thirdweb community.
2731
| `emoji_close` | Emoji you want to use as a trigger to close and lock the thread support. |
2832
| `command_prefix` | A prefix you want to use with `close` command to be recognized by the bot. |
2933
| `auto_archive_duration` | Auto Archive Duration for your threads, `10080` for 1 week (in minutes). |
34+
| `timezone` | This is the timezone use for recording the date and time for the metrics. |
35+
| `datasheet_init` | Refers to the sheet name in your google spreadsheet. This should be the first sheet in the order. |
36+
| `datasheet_response` | Refers to the sheet name in your google spreadsheet. This should be the second sheet in the order. |
37+
| `datasheet_resolve` | Refers to the sheet name in your google spreadsheet. This should be the third sheet in the order. |
3038

3139
## Environment Variables
3240

3341
```env
3442
DISCORD_BOT_TOKEN=<discord_bot_token>
3543
DISCORD_SUPPORT_ROLE_ID=<role_id>,<role_id>
44+
GOOGLE_PRIVATE_KEY=<private_key>
45+
GOOGLE_SERVICE_ACCOUNT_EMAIL=<service_email_account>
46+
GOOGLE_SPREADSHEET_ID=<google_spreadsheet_id>
3647
```
3748

3849
## Development
@@ -49,13 +60,15 @@ yarn install
4960
yarn dev
5061
```
5162

52-
## Todo
63+
## 📝 Author
5364

54-
- Analytics (in progress)
65+
The Thread-based Support Bot (thirdweb support) is developed and maintained by **[Waren Gonzaga](https://github.com/warengonzaga)**, with the help of awesome [contributors](https://github.com/warengonzaga/thirdweb-support-discord-bot/graphs/contributors) for the [thirdweb community](https://discord.gg/thirdweb).
66+
67+
[![contributors](https://contrib.rocks/image?repo=warengonzaga/thirdweb-support-discord-bot)](https://github.com/warengonzaga/thirdweb-support-discord-bot/graphs/contributors)
5568

5669
## License
5770

58-
Support Fren (thirdweb support) Discord Bot is licensed under [GNU General Public License v3](https://opensource.org/licenses/GPL-3.0).
71+
The Thread-based Support Bot (thirdweb support) is licensed under [GNU General Public License v3](https://opensource.org/licenses/GPL-3.0).
5972

6073
---
6174

code_of_conduct.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
* Demonstrating empathy and kindness toward other people
14+
* Being respectful of differing opinions, viewpoints, and experiences
15+
* Giving and gracefully accepting constructive feedback
16+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
* Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
* Trolling, insulting or derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others' private information, such as a physical or email address, without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [email protected]. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
### 4. Permanent Ban
66+
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
74+
75+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
76+
77+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
78+
79+
[homepage]: https://www.contributor-covenant.org
80+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
81+
[Mozilla CoC]: https://github.com/mozilla/diversity
82+
[FAQ]: https://www.contributor-covenant.org/faq
83+
[translations]: https://www.contributor-covenant.org/translations

contributing.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# 🎯 Contributing to Thread-based Support Bot (thirdweb support)
2+
3+
Any contributions are welcome, encouraged, and valued. See the following information below for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for me as maintainer and smooth out the experience for all involved. The community looks forward to your contributions. 🎉✌✨
4+
5+
## 📋 Code of Conduct
6+
7+
This project and everyone participating in it is governed by the Thread-based Support Bot (thirdweb support) [Code of Conduct](https://github.com/warengonzaga/ipfs-support-extension/blob/master/code_of_conduct.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to <[email protected]>.
8+
9+
## 💖 How to Contribute
10+
11+
There are many ways to contribute to this open source project. Any contributions are welcome and appreciated. Be sure to read the details of each section for you to start contributing.
12+
13+
1. Submitting PR for improvements.
14+
2. Reporting bugs.
15+
3. Star the repository.
16+
17+
---
18+
19+
💻💖☕ by [Waren Gonzaga](https://warengonzaga.com) | [He is Awesome](https://www.youtube.com/watch?v=HHrxS4diLew&t=44s) 🙏

security.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Thread-based Support Bot (thirdweb support) [![huntr](https://cdn.huntr.dev/huntr_security_badge_mono.svg)](https://huntr.dev)
2+
3+
If you discover any security related issue in this repository or in this project, please contact me with this email [[email protected]](mailto:[email protected]) or [submit a vulnerability report](https://huntr.dev/bounties/disclose/) via [huntr.dev](https://huntr.dev).
4+
5+
Thanks for helping me making my open-source projects safe for everyone, I really appreciate it.

0 commit comments

Comments
 (0)