fix: docs: add README - #32
Conversation
- README.md Fixes pistonpro0001#31 Signed-off-by: Vedant Madane <6527493+VedantMadane@users.noreply.github.com>
roli2py
left a comment
roli2py
left a comment
There was a problem hiding this comment.
It's so abstract and there are no details which could help to the newcomers. For now, it's so empty.
The project is so small, so try to analyze the project and add details about, for example, which environment variables the user must to provide or which permissions for the bot the user must permit in the Discord Developer Portal. There's already necessary info in the other issues and PRs.
| @@ -0,0 +1,23 @@ | |||
| # pistonpro0001__devbot__31 | |||
There was a problem hiding this comment.
- Why is there an italic formatting?
- There's no sense to add the author and issue number.
I think it'll better to leave the title and capitalize it:
| # pistonpro0001__devbot__31 | |
| # Devbot |
|
|
||
| ## Overview | ||
|
|
||
| Orientation guide for newcomers to `pistonpro0001__devbot__31`. |
There was a problem hiding this comment.
It's obvious that README guides the newcomers, so no need for this.
| ## Layout | ||
|
|
||
| - (see repository root) |
There was a problem hiding this comment.
There's no sense to write it.
|
|
||
| ## Quick start | ||
|
|
||
| 1. Clone this repository. |
There was a problem hiding this comment.
"the" will be sound better than "this":
| 1. Clone this repository. | |
| 1. Clone the repository. |
| ## Quick start | ||
|
|
||
| 1. Clone this repository. | ||
| 2. Install prerequisites from project files. |
There was a problem hiding this comment.
- The project uses "uv" and, therefore, it's important to use it, because it's easier to understand the problem and fix it if there's one. Other tools can introduce other problems which can complicate the problem.
- "requirements" is already used word for the files which contain prerequisites, so "requirements" will be sound better than "prerequisites".
So it's better saying to use "uv":
| 2. Install prerequisites from project files. | |
| 2. Install the requirements by "uv". |
|
|
||
| 1. Clone this repository. | ||
| 2. Install prerequisites from project files. | ||
| 3. Build and run the project's standard tests. |
There was a problem hiding this comment.
- There are no tests, for now.
- No need to build it.
- It'll be good to show how to run it:
| 3. Build and run the project's standard tests. | |
| 3. Run the project: | |
| \`\`\`bash | |
| python -m devbot | |
| \`\`\` |
|
|
||
| ## Contributing | ||
|
|
||
| Open focused pull requests with a short test plan. See [CONTRIBUTING.md](CONTRIBUTING.md) when present. |
There was a problem hiding this comment.
- It's present.
- No need for the first clause.
| Open focused pull requests with a short test plan. See [CONTRIBUTING.md](CONTRIBUTING.md) when present. | |
| See [`CONTRIBUTING.md`](CONTRIBUTING.md). |
|
|
||
| ## License | ||
|
|
||
| See the license file when present. |
There was a problem hiding this comment.
- It's present
- We can make the link to the file as in the "Contributing" chapter.
| See the license file when present. | |
| See [`LICENSE`](LICENSE). |
2 participants
Summary
docs: add README
Changes
Fixes #31