Skip to content

Conversation

@Aidoni0797
Copy link
Contributor

@Aidoni0797 Aidoni0797 commented Aug 16, 2025

User description

Adding a small file for documentation practice in my fork.


PR Type

Documentation


Description

  • Add practice documentation files for learning GitHub workflow

  • Insert badges and Russian practice note in README

  • Create training files in root and py/docs directories


Diagram Walkthrough

flowchart LR
  A["Fork Repository"] --> B["Add README badges"]
  B --> C["Create PRACTICE.md"]
  C --> D["Create PRACTICE2.md"]
  D --> E["Document learning workflow"]
Loading

File Walkthrough

Relevant files
Documentation
PRACTICE2.md
Create second practice documentation file                               

PRACTICE2.md

  • Create new practice documentation file
  • Add simple header and description for GitHub workflow learning
+3/-0     
README.md
Add badges and practice note                                                         

README.md

  • Add GitHub repository badges (stars, forks, issues)
  • Insert Russian practice note about fork and learning
+7/-0     
PRACTICE.md
Create Python docs practice file                                                 

py/docs/PRACTICE.md

  • Create practice file with Russian documentation
  • List learning objectives for documentation and PR workflow
  • Add author and date information
+8/-0     

docs: add badges and short practice note to README
docs: add PRACTICE.md with training notes
docs: add PRACTICE.md with training notes
docs: add badges and short practice note to README
docs: add PRACTICE2.md for training
@selenium-ci selenium-ci added the C-py Python Bindings label Aug 16, 2025
@qodo-merge-pro
Copy link
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Branding/Attribution

The added badges and Russian note reference SeleniumHQ; ensure this aligns with project branding and contributor guidelines, and clarify that this is a personal fork to avoid confusion in the upstream README.

![GitHub Repo stars](https://img.shields.io/github/stars/SeleniumHQ/selenium?style=social)
![GitHub forks](https://img.shields.io/github/forks/SeleniumHQ/selenium)
![GitHub issues](https://img.shields.io/github/issues/SeleniumHQ/selenium)

> Учебная практика: мой форк Selenium. Здесь я тренируюсь делать небольшие изменения (документация/форматирование), создавать ветки и открывать PR.
Badge Targets

The badges point to SeleniumHQ/selenium; confirm links and metrics should reference this repo or the fork, and consider using consistent 'style' parameters across badges.

![GitHub Repo stars](https://img.shields.io/github/stars/SeleniumHQ/selenium?style=social)
![GitHub forks](https://img.shields.io/github/forks/SeleniumHQ/selenium)
![GitHub issues](https://img.shields.io/github/issues/SeleniumHQ/selenium)

@qodo-merge-pro
Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Remove personal practice content

These badges and the practice note point to the upstream SeleniumHQ/selenium and
introduce personal practice content into the main README, which can confuse
users. Move practice text to a dedicated practice file and, if keeping badges,
scope them to your fork or remove them from upstream-facing README.

README.md [9-14]

-<!-- practice: badges for my fork -->
-![GitHub Repo stars](https://img.shields.io/github/stars/SeleniumHQ/selenium?style=social)
-![GitHub forks](https://img.shields.io/github/forks/SeleniumHQ/selenium)
-![GitHub issues](https://img.shields.io/github/issues/SeleniumHQ/selenium)
+<!-- (Practice note moved to PRACTICE2.md; upstream README remains focused) -->
 
-> Учебная практика: мой форк Selenium. Здесь я тренируюсь делать небольшие изменения (документация/форматирование), создавать ветки и открывать PR.
-
  • Apply / Chat
Suggestion importance[1-10]: 10

__

Why: This suggestion correctly identifies that adding personal practice notes and badges to the main README.md of an upstream project is inappropriate and would be confusing, which is a critical issue.

High
  • More

@diemol diemol closed this Aug 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants