Skip to content

Commit 29e822f

Browse files
committed
2 parents 765c8bd + ba478cb commit 29e822f

File tree

2 files changed

+35
-1
lines changed

2 files changed

+35
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Contributing to Pythonista Bot
2+
3+
First off, thanks for taking the time to contribute. It makes the bot substantially better. :+1:
4+
5+
The following is a set of guidelines for contributing to the repository. These are guidelines, not hard rules.
6+
7+
## Good Bug Reports
8+
9+
Please be aware of the following things when filing bug reports.
10+
11+
1. Don't open duplicate issues. Please search your issue to see if it has been asked already. Duplicate issues will be closed.
12+
2. When filing a bug about exceptions or tracebacks, please include the _complete_ traceback. Without the complete traceback the issue might be **unsolvable** and you will be asked to provide more information.
13+
3. Make sure to provide enough information to make the issue workable. The issue template will generally walk you through the process, but they are enumerated here as well:
14+
- A **summary** of your bug report. This is generally a quick sentence or two to describe the issue in human terms.
15+
- Guidance on **how to reproduce the issue**. Ideally, this should have a small code sample that allows us to run and see the issue for ourselves to debug. **Please make sure that the token is not displayed**. If you cannot provide a code snippet, then let us know what the steps were, how often it happens, etc.
16+
- Tell us **what you expected to happen**. That way we can meet that expectation.
17+
- Tell us **what actually happens**. What ends up happening in reality? It's not helpful to say "it fails" or "it doesn't work". Say _how_ it failed, do you get an exception? Does it hang? How are the expectations different from reality?
18+
19+
If the bug report is missing this information then it'll take us longer to fix the issue. We will probably ask for clarification, and barring that if no response was given then the issue will be closed.
20+
21+
## Submitting a Pull Request
22+
23+
Submitting a pull request is fairly simple, just make sure it focuses on a single aspect and doesn't manage to have scope creep, and it's probably good to go. It would be incredibly lovely if the style is consistent to that found in the project. This project follows PEP-8 guidelines (mostly) with a column limit of 125.
24+
There are provided tool rules in `pyproject.toml` for `isort`, `black` and `pyright` when committing here.
25+
There are actions that run on new PRs and if those checks fail then the PR will not be accepted.
26+
27+
### Git Commit Guidelines
28+
29+
- Use present tense (e.g. "Add feature" not "Added feature")
30+
- Limit all lines to 72 characters or fewer.
31+
- Reference issues or pull requests outside the first line.
32+
- Please use the shorthand `#123` and not the full URL.
33+
34+
If you do not meet any of these guidelines, don't fret. Chances are they will be fixed upon rebasing but please do try to meet them to remove some workload.

core/utils/logging.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ def __enter__(self: Self) -> Self:
4646

4747
self.log.setLevel(logging.INFO)
4848
handler = RotatingFileHandler(
49-
filename=self.logging_path / "Mipha.log",
49+
filename=self.logging_path / "PythonistaBot.log",
5050
encoding="utf-8",
5151
mode="w",
5252
maxBytes=self.max_bytes,

0 commit comments

Comments
 (0)