Skip to content

fix: docs: add README #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VedantMadane wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: docs: add README #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# pistonpro0001__devbot__31

@roli2py roli2py Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Why is there an italic formatting?
  2. There's no sense to add the author and issue number.

I think it'll better to leave the title and capitalize it:

Suggested change
# pistonpro0001__devbot__31
# Devbot


## Overview

Orientation guide for newcomers to `pistonpro0001__devbot__31`.

@roli2py roli2py Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's obvious that README guides the newcomers, so no need for this.


## Layout

- (see repository root)
Comment on lines +7 to +9

@roli2py roli2py Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's no sense to write it.


## Quick start

1. Clone this repository.

@roli2py roli2py Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"the" will be sound better than "this":

Suggested change
1. Clone this repository.
1. Clone the repository.

2. Install prerequisites from project files.

@roli2py roli2py Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. 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.
  2. "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":

Suggested change
2. Install prerequisites from project files.
2. Install the requirements by "uv".

3. Build and run the project's standard tests.

@roli2py roli2py Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. There are no tests, for now.
  2. No need to build it.
  3. It'll be good to show how to run it:
Suggested change
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.

@roli2py roli2py Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. It's present.
  2. No need for the first clause.
Suggested change
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.

@roli2py roli2py Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. It's present
  2. We can make the link to the file as in the "Contributing" chapter.
Suggested change
See the license file when present.
See [`LICENSE`](LICENSE).