You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/workflows/stale.yml
+1-1
Original file line number
Diff line number
Diff line change
@@ -14,4 +14,4 @@ jobs:
14
14
stale-issue-message: 'This issue is stale because it has been open for 100 days with no activity. Remove stale label or comment or this will be closed in 5 days. Please do not un-stale this issue unless it carries significant contribution.'
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+9-8
Original file line number
Diff line number
Diff line change
@@ -15,32 +15,33 @@ We use GitHub to host code, to track issues and feature requests, as well as acc
15
15
16
16
## We Use [Git Flow](https://atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
17
17
18
-
When contributing to this project, please make sure you follow this and name your branches appropriately!
18
+
When contributing to this project please make sure you follow this and name your branches appropriately!
19
19
20
20
## All Code Changes Happen Through Pull Requests
21
21
Make sure you know how Git Flow works before contributing!
22
22
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
23
23
24
24
1. Fork the repo and create your branch from `master` or `development` according to Git Flow.
25
-
2. Update the CHANGELOG.
26
-
3. If you've changed `core/*` or `bot.py`, mark changelog as "BREAKING" since plugins may break.
27
-
4. Make sure your code passes the lint checks.
28
-
5. Create Issues and pull requests!
25
+
2. If you've added code that should be tested, add tests.
26
+
3. If you've changed APIs, update the documentation.
27
+
4. Ensure the test suite passes.
28
+
5. Make sure your code lints.
29
+
6. Issue that pull request!
29
30
30
31
## Any contributions you make will be under the GNU Affero General Public License v3.0
31
32
In short, when you submit code changes, your submissions are understood to be under the same [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.en.html) that covers the project. Feel free to contact the maintainers if that's a concern.
32
33
33
34
## Report bugs using [Github Issues](https://github.com/kyb3r/modmail/issues)
34
-
We use GitHub issues to track public bugs. Report a bug by [opening a new Issue](https://github.com/kyb3r/modmail/issues/new); it's that easy!
35
+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/kyb3r/modmail/issues/new); it's that easy!
35
36
36
37
## Write bug reports with detail, background, and sample code
37
38
**Great Bug Reports** tend to have:
38
39
39
-
- A quick summary and background
40
+
- A quick summary and/or background
40
41
- Steps to reproduce
41
42
- Be specific!
42
43
- What you expected would happen
43
-
- What *actually* happens
44
+
- What actually happens
44
45
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
Modmail is similar to Reddit's Modmail, both in functionality and purpose. It serves as a shared inbox for server staff to communicate with their users in a seamless way.
53
+
Modmail is similar to Reddit's Modmail both in functionality and purpose. It serves as a shared inbox for server staff to communicate with their users in a seamless way.
50
54
51
55
This bot is free for everyone and always will be. If you like this project and would like to show your appreciation, you can support us on **[Patreon](https://www.patreon.com/kyber)**, cool benefits included!
52
56
53
57
## How does it work?
54
58
55
-
When a member sends a direct message to the bot, Modmail will create a channel or "thread" into a designated category. All further DM messages will automatically relay to that channel; any available staff can respond within the channel.
59
+
When a member sends a direct message to the bot, Modmail will create a channel or "thread" within an isolated category. All further DM messages will automatically relay to that channel, for any available staff can respond within the channel.
56
60
57
-
Our Logviewer will save the threads so you can view previous threads through their corresponding log link. Here is an [**example**](https://logs.logviewer.tech/example).
61
+
All threads are logged and you can view previous threads through their corresponding log link. Here is an [**example**](https://logs.logviewer.tech/example).
58
62
59
63
## Features
60
64
61
65
***Highly Customisable:**
62
66
* Bot activity, prefix, category, log channel, etc.
63
67
* Command permission system.
64
-
* Interface elements (color, responses, reactions, etc.).
68
+
* Interface elements (color, responses, reactions, etc).
65
69
* Snippets and *command aliases*.
66
70
* Minimum duration for accounts to be created before allowed to contact Modmail (`account_age`).
67
-
* Minimum length for members to be in the guild before allowed to contact Modmail (`guild_age`).
71
+
* Minimum duration for members to be in the guild before allowed to contact Modmail (`guild_age`).
68
72
69
73
***Advanced Logging Functionality:**
70
74
* When you close a thread, Modmail will generate a [log link](https://logs.logviewer.tech/example) and post it to your log channel.
@@ -86,11 +90,11 @@ This list is ever-growing thanks to active development and our exceptional contr
86
90
87
91
Where can I find the Modmail bot invite link?
88
92
89
-
Unfortunately, due to how this bot functions, it cannot be invited. The lack of an invite link is to ensure an individuality to your server and grant you full control over your bot and data. Nonetheless, you can quickly obtain a free copy of Modmail for your server by following one of the methods listed below (roughly takes 15 minutes of your time).
93
+
Unfortunately, due to how this bot functions, it cannot be invited. This is to ensure the individuality to your server and grant you full control over your bot and data. Nonetheless, you can easily obtain a free copy of Modmail for your server by following one of the methods listed below (roughly takes 15 minutes of your time)...
90
94
91
95
### Heroku
92
96
93
-
You can host this bot on Heroku.
97
+
This bot can be hosted on Heroku.
94
98
95
99
Installation via Heroku is possible with your web browser alone.
96
100
The [**installation guide**](https://github.com/kyb3r/modmail/wiki/Installation) (which includes a video tutorial!) will guide you through the entire installation process. If you run into any problems, join our [Modmail Discord Server](https://discord.gg/etJNHCQ) for help and support.
@@ -104,11 +108,11 @@ To configure automatic updates:
104
108
105
109
### Hosting for Patreons
106
110
107
-
If you don't want to go through the trouble of setting up your very own Modmail botor wish to support this project, we got a solution for you! We offer the complete installation, hosting, and maintenance of your Modmail with [**Patreon**](https://patreon.com/kyber). Join our [Modmail Discord Server](https://discord.gg/etJNHCQ) for more info!
111
+
If you don't want to go through the trouble of setting up your very own Modmail bot, and/or want to support this project, we offer the all inclusive installation, hosting and maintenance of your Modmail with [**Patreon**](https://patreon.com/kyber). Join our [Modmail Discord Server](https://discord.gg/etJNHCQ) for more info!
108
112
109
113
### Locally
110
114
111
-
Local hosting of Modmail is also possible. First, you will need [`Python 3.7`](https://www.python.org/downloads/release/python-376/).
115
+
Local hosting of Modmail is also possible, first you will need [`Python 3.7`](https://www.python.org/downloads/).
112
116
113
117
Follow the [**installation guide**](https://github.com/kyb3r/modmail/wiki/Installation) and disregard deploying the Heroku bot application. If you run into any problems, join our [Modmail Discord Server](https://discord.gg/etJNHCQ) for help and support.
114
118
@@ -143,20 +147,30 @@ You can build your own Docker image:
143
147
$ docker build . --tag=modmail
144
148
```
145
149
146
-
Or run directly from a pre-built version from https://hub.docker.com/.
150
+
or run directly from a pre-built version from https://hub.docker.com/. Currently there are two community release of Modmail:
@@ -175,16 +189,16 @@ Become a sponsor on [Patreon](https://patreon.com/kyber).
175
189
## Plugins
176
190
177
191
Modmail supports the use of third-party plugins to extend or add functionalities to the bot.
178
-
Plugins allow niche features as well as anything else outside of the scope of the core functionality of Modmail.
192
+
This allows niche features as well as anything else outside of the scope of the core functionality of Modmail.
179
193
180
-
You can find a list of third-party plugins using the `?plugins registry` command or visit the [Unofficial List of Plugins](https://github.com/kyb3r/modmail/wiki/Unofficial-List-of-Plugins) for a list of plugins contributed by the community.
194
+
A list of third-party plugins can be found using the `?plugins registry` command or visit the [Unofficial List of Plugins](https://github.com/kyb3r/modmail/wiki/Unofficial-List-of-Plugins) for a list of plugins contributed by the community.
181
195
182
196
To develop your own, check out the [plugins documentation](https://github.com/kyb3r/modmail/wiki/Plugins).
183
197
184
198
Plugins requests and support is available in our [Modmail Plugins Server](https://discord.gg/4JE4XSW).
185
199
186
200
## Contributing
187
201
188
-
Contributions to Modmail are always welcome, whether it be improvements to the documentation or new functionality, please feel free to make the change. Check out our [contributing guidelines](https://github.com/kyb3r/modmail/blob/master/CONTRIBUTING.md) before you get started.
202
+
Contributions to Modmail are always welcome, whether it be improvements to the documentation or new functionality, please feel free to make the change. Check out our contribution [guidelines](https://github.com/kyb3r/modmail/blob/master/CONTRIBUTING.md) before you get started.
189
203
190
204
If you like this project and would like to show your appreciation, support us on **[Patreon](https://www.patreon.com/kyber)**!
0 commit comments