-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
added information about web examples for english document #2492
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.
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
Conversation
✅ Deploy Preview for selenium-dev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
PR Compliance Guide 🔍(Compliance updated until commit 5bf4118)Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label Previous compliance checksCompliance check up to commit f669d9f
|
||||||||||||||||||||||||||||||||||||||||||
|
please note this is only done for english version of the document. for other languages translations will be required. |
PR Code Suggestions ✨No code suggestions found for the PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you put the same text in the other languages? At least it will serve as a placeholder.
|
let me see, if i could, i would do it Diego @diemol |
|
#2525 does for 2 more files. unable to do for .ja file, don't understand. |
|
Why don't you put all the changes in the same PR? |
|
What is the issue with them being separate Diego? @diemol at the end we are getting the work being completed. |
|
Typically, a PR contains all changes related to the same logical unit or change set. Breaking the same unit into several PRs makes it harder for a reviewer to understand the scope and changes related to it. It should be fine in this case because it is a small change, but in general, a single PR with all related changes is preferred. |
* added information about web examples for the english document * Replicating change from contributing.en.md to other files --------- [deploy site] 4dc5f22
User description
Thanks for contributing to the Selenium site and documentation!
A PR well described will help maintainers to review and merge it quickly
Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, and help reviewers by making them as simple and short as possible.
Description
When people provide code examples for documentation, it is recommended that they use web pages
listed on the link - https://www.selenium.dev/selenium/web/
to ensure we have a standard practice and the examples always run.
Motivation and Context
people may use web pages which may or may not run in future.
by doing this our code examples will have some standard
Types of changes
Checklist
PR Type
Documentation
Description
Added guidance for using standardized test web pages in code examples
Recommended using selenium.dev/selenium/web/ for consistent documentation examples
Diagram Walkthrough
File Walkthrough
contributing.en.md
Added standardized web page guidance for exampleswebsite_and_docs/content/documentation/about/contributing.en.md
examples