Fix placeholder project link in README#15
Conversation
Replaced placeholder URL with correct repository link.
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughDocumentation and site markup were reformatted and expanded: README and CONTRIBUTING updated with standardized examples, double-quote styling, and new contributor guidance; index.html adds branded header/logo and related CSS; source files in Changes
Sequence Diagram(s)(omitted — changes are documentation/formatting and minor non-functional edits) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
| <div align="center"> | ||
|
|
||
| [](https://TODO.aossie/) | ||
| [](https://github.com/AOSSIE-Org/SocialShareButton) |
| <!-- Organization Logo --> | ||
| <div align="center" style="display: flex; align-items: center; justify-content: center; gap: 16px;"> | ||
| <img alt="Stability Nexus" src="public/aossie_logo.svg" width="175"> | ||
| <!-- <img src="public/todo-project-logo.svg" width="175" /> --> |
There was a problem hiding this comment.
Can you suggest a logo for SocialShareButton??
(according to your creativity)
There was a problem hiding this comment.
<img width="300 alt="socialsharebutton Logo" src="https://github.com/user-attachments/assets/547b1d15-d70a-4a66-b2c2-0937b1e710ba" />
There was a problem hiding this comment.
any other??
text inside it is not preferable from myside
|
|
||
| This project is licensed under the GNU General Public License v3.0. | ||
| See the [LICENSE](LICENSE) file for details. | ||
|
|
There was a problem hiding this comment.
can you add contributors section in readme at bottom similar to our template repo??
## 💪 Thanks To All Contributors
Thanks a lot for spending your time helping TODO grow. Keep rocking 🥂
[](https://github.com/AOSSIE-Org/TODO/graphs/contributors)
© 2025 AOSSIE
There was a problem hiding this comment.
yeah , definitely i will do it asap
There was a problem hiding this comment.
Hi @kpj2006,
I've added the contributors section at the bottom of the README as requested. Please let me know if any changes are needed.
Added contributors section at the bottom of README using contrib.rocks to dynamically display all repository contributors.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
693-693: Consider updating the copyright year.The new contributors section ends with “© 2025 AOSSIE.” If this is intended to reflect the current year, it should now be 2026.
📝 Proposed tweak
-© 2025 AOSSIE +© 2026 AOSSIE🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 693, Update the trailing copyright year string "© 2025 AOSSIE" in the README to the current year by replacing "© 2025 AOSSIE" with "© 2026 AOSSIE" so the contributors section reflects 2026.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@README.md`:
- Line 693: Update the trailing copyright year string "© 2025 AOSSIE" in the
README to the current year by replacing "© 2025 AOSSIE" with "© 2026 AOSSIE" so
the contributors section reflects 2026.
|
@sravanya1912 have you include logo in svg format ?? |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
README.md (2)
74-79: Keep “Basic HTML Usage” under the Installation section hierarchy.
## Installationis immediately followed by another H2. This makes Installation look empty in markdown navigation.Suggested fix
## Installation -## Basic HTML Usage (Vanilla JS) +### Basic HTML Usage (Vanilla JS) If you are using plain HTML, you can quickly integrate the Social Share Button without any framework.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 74 - 79, The README currently places "## Basic HTML Usage (Vanilla JS)" as a sibling H2 to "## Installation", making Installation appear empty in navigation; change the "Basic HTML Usage (Vanilla JS)" heading to a subheading (e.g., "### Basic HTML Usage (Vanilla JS)") so it is nested under the "## Installation" section and update any other related headings under Installation to the same level to preserve hierarchy.
727-727: Consider slightly more formal contributor-thanks wording.Line 727 is a bit informal for project docs; a neutral phrasing reads cleaner.
Suggested fix
-Thanks a lot for spending your time helping SocialShareButton grow. Keep rocking 🥂 +Thank you for taking the time to help SocialShareButton grow. Keep rocking 🥂🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 727, Replace the informal thank-you sentence "Thanks a lot for spending your time helping SocialShareButton grow. Keep rocking 🥂" with a more neutral, formal contributor acknowledgement; for example change that line to a concise professional sentence such as "Thank you for contributing to SocialShareButton." or "We appreciate your contribution to SocialShareButton." ensuring the emoji and informal phrases are removed.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@index.html`:
- Around line 224-226: The header logo image inside the h1.brand currently uses
a non-descriptive alt ("Logo") and is redundant with the visible brand text;
update the <img> tag (class="logo") to be treated as decorative by changing its
alt attribute to an empty string (alt="") so assistive tech ignores it, and
ensure no other accessibility attributes (like role or aria-label) are added
that would duplicate the visible "SocialShareButton" text.
---
Nitpick comments:
In `@README.md`:
- Around line 74-79: The README currently places "## Basic HTML Usage (Vanilla
JS)" as a sibling H2 to "## Installation", making Installation appear empty in
navigation; change the "Basic HTML Usage (Vanilla JS)" heading to a subheading
(e.g., "### Basic HTML Usage (Vanilla JS)") so it is nested under the "##
Installation" section and update any other related headings under Installation
to the same level to preserve hierarchy.
- Line 727: Replace the informal thank-you sentence "Thanks a lot for spending
your time helping SocialShareButton grow. Keep rocking 🥂" with a more neutral,
formal contributor acknowledgement; for example change that line to a concise
professional sentence such as "Thank you for contributing to SocialShareButton."
or "We appreciate your contribution to SocialShareButton." ensuring the emoji
and informal phrases are removed.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
public/socialsharebutton.svgis excluded by!**/*.svgsrc/favicon.svgis excluded by!**/*.svg
📒 Files selected for processing (2)
README.mdindex.html
There was a problem hiding this comment.
🧹 Nitpick comments (1)
index.html (1)
203-205: Scope the mobile font-size rule to the branded heading only.Line 203 currently targets both
h1and.brand; targetingh1.brandis safer and avoids accidental styling of futureh1elements.Proposed CSS refinement
- h1,.brand { + h1.brand { font-size: 32px; }🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@index.html` around lines 203 - 205, The selector currently targets both h1 and .brand (selector "h1,.brand"); change it to target only branded headings by updating the selector to "h1.brand" so the mobile font-size rule applies only to elements that are both an h1 and have the .brand class (update the rule where the selector is defined).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@index.html`:
- Around line 203-205: The selector currently targets both h1 and .brand
(selector "h1,.brand"); change it to target only branded headings by updating
the selector to "h1.brand" so the mobile font-size rule applies only to elements
that are both an h1 and have the .brand class (update the rule where the
selector is defined).
|
@kpj2006 yes, i have put the socialsharebutton logo in svg format . |
kpj2006
left a comment
kpj2006
left a comment
There was a problem hiding this comment.
you have placed 2 svg image, any specific reason to include the other one?
additionally, thanks for formatting or linting in index.html.
could you do necessary formatting in src folder also??
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8" /> | ||
| <title>Social Share Button Demo</title> | ||
| <link | ||
| rel="stylesheet" | ||
| href="https://cdn.jsdelivr.net/gh/AOSSIE-Org/SocialShareButton@v1.0.3/src/social-share-button.css" | ||
| /> | ||
| </head> | ||
| <body> | ||
| <div id="share-button"></div> | ||
|
|
||
| <script src="https://cdn.jsdelivr.net/gh/AOSSIE-Org/SocialShareButton@v1.0.3/src/social-share-button.js"></script> | ||
| <script> | ||
| new window.SocialShareButton({ | ||
| container: "#share-button", | ||
| }); | ||
| </script> | ||
| </body> | ||
| </html> |
There was a problem hiding this comment.
previous one is perfect, no need to change it.
| ### Via CDN (Recommended) | ||
| ## Basic HTML Usage (Vanilla JS) | ||
|
|
||
| If you are using plain HTML, you can quickly integrate the Social Share Button without any framework. |
|
@kpj2006 One is used as the main project logo and the other is used as the favicon for browser tabs. |
|
@kpj2006 I have formatted the files in the src folder , contributing file also and made the requested updates in README. |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
699-699: Consider a slightly more formal gratitude sentence.Optional docs polish: replacing “Thanks a lot…” with a more formal phrase would improve tone consistency.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 699, Replace the informal sentence "Thanks a lot for spending your time helping SocialShareButton grow. Keep rocking 🥂" in the README with a more formal gratitude line such as "Thank you for contributing to SocialShareButton; your support is appreciated." Keep the tone professional and remove emojis to match the project's documentation style.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 107-109: Add a fenced-code language identifier (e.g., "text") to
the unlabeled fenced code blocks that currently contain the lines "type: short
description" and the block with "feat: add Twitter share support / fix: resolve
mobile button spacing issue / docs: improve README installation section" so that
each opening "```" becomes "```text"; update both occurrences to satisfy
markdownlint MD040.
---
Nitpick comments:
In `@README.md`:
- Line 699: Replace the informal sentence "Thanks a lot for spending your time
helping SocialShareButton grow. Keep rocking 🥂" in the README with a more
formal gratitude line such as "Thank you for contributing to SocialShareButton;
your support is appreciated." Keep the tone professional and remove emojis to
match the project's documentation style.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 328279b0-8d56-42db-bf7e-eae1fff94a44
📒 Files selected for processing (5)
CONTRIBUTING.mdREADME.mdsrc/social-share-button-react.jsxsrc/social-share-button.csssrc/social-share-button.js
✅ Files skipped from review due to trivial changes (2)
- src/social-share-button.css
- src/social-share-button.js
| ``` | ||
| type: short description | ||
| ``` |
There was a problem hiding this comment.
Add fenced-code language identifiers to satisfy markdownlint (MD040).
Line 107 and Line 113 use unlabeled fenced code blocks. Add a language (e.g., text) to resolve lint warnings.
Proposed fix
-```
+```text
type: short description- +text
feat: add Twitter share support
fix: resolve mobile button spacing issue
docs: improve README installation section
Also applies to: 113-117
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 107-107: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@CONTRIBUTING.md` around lines 107 - 109, Add a fenced-code language
identifier (e.g., "text") to the unlabeled fenced code blocks that currently
contain the lines "type: short description" and the block with "feat: add
Twitter share support / fix: resolve mobile button spacing issue / docs: improve
README installation section" so that each opening "```" becomes "```text";
update both occurrences to satisfy markdownlint MD040.
|
lgtm |
|
@sravanya1912 @shubh2294 thanks for contribution!! |
|
@sravanya1912 @shubh2294 could you check where in readme the logo showing? |
|
@kpj2006
The image is loaded from the Also, I noticed that the
|
|
@sravanya1912 let's talk on discord, link is in top of readme. |
* Corrected Cleanup logic for interval code Path * Code rabbit review * lint error resolved * minor changes * Indentation error resolve * docs: add preact wrapper lifecycle comments * fix: prevent stale props in preact init * remove JSDoc from preact wrapper * feat: add analytics options to preact wrapper * fix: avoid stringifying analytics plugins
3 participants
This PR replaces the placeholder project URL in the README with the correct repository link.
Summary by CodeRabbit