Skip to content

updated Readme.md #891

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

updated Readme.md #891

wants to merge 2 commits into from

Conversation

syedtayefali369
Copy link

Overall Checklist

for password-rules.json

  • The given rule isn't particularly standard and obvious for password managers
  • Generated passwords have been tested from this rule using the Password Rules Validation Tool
  • Information has been included about the website's requirements (eg. screenshots, error messages, steps during experimentation, etc.)
  • The PR isn't documenting something that would be a common practice among password managers (e.g. minimal length of 6)

for change-password-URLs.json

  • There is no Well-Known URL for Changing Passwords (https://example.com/.well-known/change-password)
  • The URL either makes the experience better or no worse than being directed to just the domain in a non-logged-in state

for shared-credentials.json

  • There's evidence the domains are currently related (SSL certificates, DNS entries, valid links between sites, legal documents etc.)
  • If using shared, the new group serves login pages on each of the included domains, and those login pages accept accounts from the others. (For example, we wouldn't use a shared association from google.co.il to google.com, because google.co.il redirects to accounts.google.com for sign in.)
  • If using from and to, the new group, the from domain(s) redirect to the to domain to log in.

for shared-credentials-historical.json

  • You believe that the domains were associated at some point in the past and can explain that relationship

---

**Key Improvements:**
1. **Simplified Navigation:** Added a table of contents and clear section headers.
2. **Visual Cues:** Used badges, emojis, and code blocks to highlight key elements.
3. **Conciseness:** Shortened paragraphs into bullet points and subheadings.
4. **Examples:** Added JSON snippets to illustrate entries.
5. **Contributor Focus:** Highlighted common contribution types and verification steps.
6. **Link Formatting:** Ensured all files/URLs are consistently linked.
---

### Key Improvements:
1. **Visual Hierarchy**: Clear sections with badges, headers, and bullet points.
2. **Examples**: Added JSON snippets to illustrate entries.
3. **Contributor Focus**: Streamlined steps and common contribution types.
4. **Links**: All resources and processes are hyperlinked for easy navigation.
5. **Brevity**: Removed redundant explanations while retaining critical details.
Copy link
Author

@syedtayefali369 syedtayefali369 left a comment

Choose a reason for hiding this comment

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


Key Improvements:

  1. Visual Hierarchy: Clear sections with badges, headers, and bullet points.
  2. Examples: Added JSON snippets to illustrate entries.
  3. Contributor Focus: Streamlined steps and common contribution types.
  4. Links: All resources and processes are hyperlinked for easy navigation.
  5. Brevity: Removed redundant explanations while retaining critical details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant