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/CONTRIBUTING.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -30,11 +30,11 @@ Pull requests are the best way to propose changes to the codebase. We actively w
30
30
## Any contributions you make will be under the GNU Affero General Public License v3.0
31
31
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
32
33
-
## 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!
33
+
## Report bugs using [Github Issues](https://github.com/modmail-dev/modmail/issues)
34
+
We use GitHub issues to track public bugs. Report a bug by [opening a new Issue](https://github.com/modmail-dev/modmail/issues/new); it's that easy!
35
35
36
36
## Find pre-existing issues to tackle
37
-
Check out our [unstaged issue tracker](https://github.com/kyb3r/modmail/issues?q=is%3Aissue+is%3Aopen+-label%3Astaged) and start helping out!
37
+
Check out our [unstaged issue tracker](https://github.com/modmail-dev/modmail/issues?q=is%3Aissue+is%3Aopen+-label%3Astaged) and start helping out!
@@ -96,23 +96,23 @@ There are a few options for hosting your very own dedicated Modmail bot.
96
96
97
97
### Patreon Hosting
98
98
99
-
If you don't want the trouble of renting and configuring your server to host Modmail, we got a solution for you! We offer hosting and maintenance of your own, private Modmail bot (including a Logviewer) through [**Patreon**](https://patreon.com/kyber). Join our [Modmail Discord Server](https://discord.gg/etJNHCQ) for more info!
99
+
If you don't want the trouble of renting and configuring your server to host Modmail, we got a solution for you! We offer hosting and maintenance of your own, private Modmail bot (including a Logviewer) through [**Patreon**](https://patreon.com/kyber). Join our [Modmail Discord Server](https://discord.gg/cnUpwrnpYb) for more info!
100
100
101
101
### Local hosting (General Guide)
102
102
103
-
Modmail can be hosted on any modern hardware, including your PC. For stability and reliability, we suggest purchasing a cloud server (VPS) for under $10/mo. If you need recommendations on choosing a VPS, join our [Discord server](https://discord.gg/j5e9p8w), and we'll send you a list of non-affiliated hosting providers. Alternatively, we can host Modmail for you when you're subscribed to our [Patreon](https://patreon.com/kyber).
103
+
Modmail can be hosted on any modern hardware, including your PC. For stability and reliability, we suggest purchasing a cloud server (VPS) for under $10/mo. If you need recommendations on choosing a VPS, join our [Discord server](https://discord.gg/cnUpwrnpYb), and we'll send you a list of non-affiliated hosting providers. Alternatively, we can host Modmail for you when you're subscribed to our [Patreon](https://patreon.com/kyber).
104
104
105
105
This guide assumes you've downloaded [`Python 3.10`](https://www.python.org/downloads/release/python-376/) and added python and pip to PATH.
2. Create a Discord bot account, grant the necessary intents, and invite the bot ([guide](https://github.com/kyb3r/modmail/wiki/Installation#2-discord-bot-account))
113
-
3. Create a free MongoDB database ([guide](https://github.com/kyb3r/modmail/wiki/Installation-(cont.)#3-create-a-database), follow it carefully!)
112
+
2. Create a Discord bot account, grant the necessary intents, and invite the bot ([guide](https://github.com/modmail-dev/modmail/wiki/Installation#2-discord-bot-account))
113
+
3. Create a free MongoDB database ([guide](https://github.com/modmail-dev/modmail/wiki/Installation-(cont.)#3-create-a-database), follow it carefully!)
114
114
4. Rename the file `.env.example` to `.env` and fill it with appropriate values
115
-
- If you can't find `.env.example` because it's hidden, create a new text file named `.env`, then copy the contents of [this file](https://raw.githubusercontent.com/kyb3r/modmail/master/.env.example) and replace the placeholders with their values
115
+
- If you can't find `.env.example` because it's hidden, create a new text file named `.env`, then copy the contents of [this file](https://raw.githubusercontent.com/modmail-dev/modmail/master/.env.example) and replace the placeholders with their values
116
116
- If you're on Windows and cannot save the file as `.env`, save it as `.env.` instead (this only applies to Windows!)
117
117
- If you do not have a Logviewer yet, leave the `LOG_URL` field as-is
118
118
5. Update pip, install pipenv, and install dependencies using pipenv
7. Set up the Logviewer, see the [Logviewer installation guide](https://github.com/kyb3r/logviewer)
128
+
7. Set up the Logviewer, see the [Logviewer installation guide](https://github.com/modmail-dev/logviewer)
129
129
130
130
### Local Hosting (Docker)
131
131
132
132
We provide support for Docker to simplify the deployment of Modmail and Logviewer.
133
133
We assume you already have Docker and Docker Compose Plugin installed, if not, see [here](https://docs.docker.com/get-docker/).
134
134
135
-
1. Create a Discord bot account, grant the necessary intents, and invite the bot ([guide](https://github.com/kyb3r/modmail/wiki/Installation#2-discord-bot-account))
136
-
2. Create a file named `.env`, then copy the contents of [this file](https://raw.githubusercontent.com/kyb3r/modmail/master/.env.example) and replace the placeholders with their values
137
-
3. Create a file named `docker-compose.yml`, then copy the contents of [this file](https://raw.githubusercontent.com/kyb3r/modmail/master/docker-compose.yml), do not change anything!
135
+
1. Create a Discord bot account, grant the necessary intents, and invite the bot ([guide](https://github.com/modmail-dev/modmail/wiki/Installation#2-discord-bot-account))
136
+
2. Create a file named `.env`, then copy the contents of [this file](https://raw.githubusercontent.com/modmail-dev/modmail/master/.env.example) and replace the placeholders with their values
137
+
3. Create a file named `docker-compose.yml`, then copy the contents of [this file](https://raw.githubusercontent.com/modmail-dev/modmail/master/docker-compose.yml), do not change anything!
138
138
4. Start the bot
139
139
```console
140
140
$ docker compose up -d
@@ -147,22 +147,22 @@ Our Docker images are hosted on [GitHub Container Registry](ghcr.io), you can bu
147
147
$ docker build --tag=modmail:master .
148
148
```
149
149
150
-
Then simply remove `ghcr.io/kyb3r/` from the `docker-compose.yml` file.
150
+
Then simply remove `ghcr.io/modmail-dev/` from the `docker-compose.yml` file.
151
151
152
152
### Local Hosting (OS-Specific)
153
153
154
-
This guide is a WIP. Join our [Discord server](https://discord.gg/j5e9p8w) for more info.
154
+
This guide is a WIP. Join our [Discord server](https://discord.gg/cnUpwrnpYb) for more info.
155
155
156
156
### Platform as a Service (PaaS)
157
157
158
158
You can host this bot on Heroku (no longer free).
159
159
160
160
Installation via Heroku is possible with your web browser alone.
161
-
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.
161
+
The [**installation guide**](https://github.com/modmail-dev/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/cnUpwrnpYb) for help and support.
162
162
163
163
When using Heroku, you can configure automatic updates:
164
164
- Login to [GitHub](https://github.com/) and verify your account.
165
-
-[Fork the repo](https://github.com/kyb3r/modmail/fork).
165
+
-[Fork the repo](https://github.com/modmail-dev/modmail/fork).
166
166
- Install the [Pull app](https://github.com/apps/pull) for your fork.
167
167
- Then go to the Deploy tab in your [Heroku account](https://dashboard.heroku.com/apps) of your bot app, select GitHub and connect your fork (usually by typing "Modmail").
168
168
- Turn on auto-deploy for the `master` branch.
@@ -213,20 +213,20 @@ Become a sponsor on [Patreon](https://patreon.com/kyber).
213
213
Modmail supports the use of third-party plugins to extend or add functionalities to the bot.
214
214
Plugins allow niche features as well as anything else outside of the scope of the core functionality of Modmail.
215
215
216
-
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.
216
+
You can find a list of third-party plugins using the `?plugins registry` command or visit the [Unofficial List of Plugins](https://github.com/modmail-dev/modmail/wiki/Unofficial-List-of-Plugins) for a list of plugins contributed by the community.
217
217
218
-
To develop your own, check out the [plugins documentation](https://github.com/kyb3r/modmail/wiki/Plugins).
218
+
To develop your own, check out the [plugins documentation](https://github.com/modmail-dev/modmail/wiki/Plugins).
219
219
220
-
Plugins requests and support are available in our [Modmail Support Server](https://discord.gg/j5e9p8w).
220
+
Plugins requests and support are available in our [Modmail Support Server](https://discord.gg/cnUpwrnpYb).
221
221
222
222
## Contributing
223
223
224
-
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/.github/CONTRIBUTING.md) before you get started.
224
+
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/modmail-dev/modmail/blob/master/.github/CONTRIBUTING.md) before you get started.
225
225
226
226
If you like this project and would like to show your appreciation, support us on **[Patreon](https://www.patreon.com/kyber)**!
227
227
228
228
## Beta Testing
229
229
230
-
Our [development](https://github.com/kyb3r/modmail/tree/development) branch is where most of our features are tested before public release. Be warned that there could be bugs in various commands so keep it away from any large servers you manage.
230
+
Our [development](https://github.com/modmail-dev/modmail/tree/development) branch is where most of our features are tested before public release. Be warned that there could be bugs in various commands so keep it away from any large servers you manage.
231
231
232
232
If you wish to test the new features and play around with them, feel free to join our [Public Test Server](https://discord.gg/v5hTjKC). Bugs can be raised within that server or in our Github issues (state that you are using the development branch though).
0 commit comments