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: CONTRIBUTING.md
+7-10Lines changed: 7 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ Additionally, linked below are some helpful resources:
24
24
If you are new to contributing to open-source projects on GitHub, the general workflow is as follows:
25
25
26
26
1.[Fork](https://w3schools.com/git/git_remote_fork.asp) this [repository](https://phoenixnap.com/kb/what-is-a-git-repository#ftoc-heading-1) and [clone](https://w3schools.com/git/git_clone.asp) it
27
-
2. Create a [branch](https://w3schools.com/git/git_remote_branch.asp)off main
27
+
2. Create a [branch](https://w3schools.com/git/git_remote_branch.asp)from `main`
28
28
3. Make your changes and [commit](https://w3schools.com/git/git_commit.asp) them
29
29
4.[Push](https://w3schools.com/git/git_push_to_remote.asp) your local [branch](https://w3schools.com/git/git_remote_branch.asp) to your remote fork
30
30
5. Open a new [pull request on GitHub](https://w3schools.com/git/git_remote_send_pull_request.asp)
@@ -44,20 +44,20 @@ If you find an issue with TeX-Bot, the best place to report it is through the is
44
44
If you are looking for issues to contribute code to, it's a good idea to look at the [issues labelled "good-first-issue"](https://github.com/CSSUoB/TeX-Bot-Py-V2/issues?q=label%3A%22good+first+issue%22)!
45
45
46
46
When submitting an issue, please be as descriptive as possible.
47
-
If you are submitting a bug report, please include the steps to reproduce the bug, and the environment it is in.
47
+
If you are submitting a bug report, please include the steps to reproduce the bug and the environment it is in.
48
48
If you are submitting a feature request, please include the steps to implement the feature.
49
49
50
50
## Repository Structure
51
51
52
52
### Top level files
53
53
54
54
*[`main.py`](main.py): is the main entrypoint to instantiate the [`Bot` object](https://docs.pycord.dev/stable/api/clients.html#discord.Bot) & run it
55
-
*[`exceptions.py`](exceptions.py): contains common [exception](https://docs.python.org/3/tutorial/errors) subclasses that may be raised when certain errors occur
56
55
*[`config.py`](config.py): retrieves the [environment variables](README.md#setting-environment-variables) & populates the correct values into the `settings` object
57
56
58
57
### Other significant directories
59
58
60
59
*[`cogs/`](cogs): contains all the [cogs](https://guide.pycord.dev/popular-topics/cogs) within this project, see [below](#cogs) for more information
60
+
*[`exceptions/`](exceptions): contains common [exception](https://docs.python.org/3/tutorial/errors) subclasses that may be raised when certain errors occur
61
61
*[`utils/`](utils): contains common utility classes & functions used by the top-level modules & cogs
62
62
*[`db/core/models/`](db/core/models): contains all the [database ORM models](https://docs.djangoproject.com/en/stable/topics/db/models) to interact with storing information longer-term (between individual command events)
63
63
*[`tests/`](tests): contains the complete test suite for this project, based on the [Pytest framework](https://pytest.org)
@@ -92,16 +92,16 @@ There are separate cog files for each activity, and one [`__init__.py`](cogs/__i
92
92
*[`cogs/remind_me.py`](cogs/remind_me.py): cogs to ask TeX-Bot to send a reminder message at a later date
93
93
94
94
*[`cogs/send_get_roles_reminders.py`](cogs/send_get_roles_reminders.py): cogs relating to sending reminders, to Discord members, about opt-in roles.
95
-
(See [Repeated Tasks Conditions](README.md#repeated-tasks-conditions) for which conditions are required to be met, to execute this task)
95
+
(See [Repeated Tasks Conditions](README.md#repeated-tasks-conditions) for which conditions are required to be met to execute this task)
96
96
97
97
*[`cogs/send_introduction_reminders.py`](cogs/send_introduction_reminders.py): cogs relating to sending reminders, to Discord members, about introducing themselves.
98
-
(See [Repeated Tasks Conditions](README.md#repeated-tasks-conditions) for which conditions are required to be met, to execute this task)
98
+
(See [Repeated Tasks Conditions](README.md#repeated-tasks-conditions) for which conditions are required to be met to execute this task)
99
99
100
100
*[`cogs/source.py`](cogs/source.py): cogs for displaying information about the source-code of this project
101
101
102
102
*[`cogs/startup.py`](cogs/startup.py): cogs for startup & bot initialisation
103
103
104
-
*[`cogs/stats.py`](cogs/stats.py): cogs for displaying stats about your group's Discord guild, as well as its channels & Discord members
104
+
*[`cogs/stats/`](cogs/stats): cogs for displaying stats about your group's Discord guild, as well as its channels & Discord members
105
105
106
106
*[`cogs/strike.py`](cogs/strike.py): cogs for applying moderation actions to Discord members
107
107
@@ -159,9 +159,6 @@ It can be run with the following command:
159
159
uv run mypy .
160
160
```
161
161
162
-
Although there is [a PyCharm plugin](https://github.com/leinardi/mypy-pycharm#mypy-pycharm) to provide GUI control & inline warnings for [mypy](https://mypy-lang.org), it has been rather temperamental recently.
163
-
So it is suggested to avoid using it, and run [mypy](https://mypy-lang.org) from the command-line instead.
164
-
165
162
#### PyMarkdown
166
163
167
164
[PyMarkdown](https://github.com/jackdewinter/pymarkdown) is a static analysis [Markdown](https://markdownguide.org/getting-started#what-is-markdown)[linter](https://wikipedia.org/wiki/Lint_(software)), which will alert you to possible formatting mistakes in your [MarkDown](https://markdownguide.org/getting-started#what-is-markdown) files.
@@ -205,7 +202,7 @@ Please note that any contributions you make will be made under the terms of the
205
202
206
203
## Guidance
207
204
208
-
We aim to get more people involved with our projects, and help build members' confidence in using git and contributing to open-source.
205
+
We aim to get more people involved with our projects and help build members' confidence in using git and contributing to open-source.
209
206
If you see an error, we encourage you to **be bold** and fix it yourself, rather than just raising an issue.
210
207
If you are stuck, need help, or have a question, the best place to ask is on our Discord.
0 commit comments