search

shravan20 / github-readme-quotes

Dynamic quote generator for your GitHub readmes | Give a poetic touch to readmes
https://github-readme-quotes-returns.vercel.app/
MIT License
278 stars 149 forks source link

Add Customizable Border Color Option to Default Layout (#332) #333

Open marceloams opened 3 weeks ago

marceloams commented 3 weeks ago

Overview

This PR introduces an option to customize the border color in the default layout, enhancing the visual flexibility of the templates.

Changes

Closes #332.

Summary by CodeRabbit

vercel[bot] commented 3 weeks ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
github-readme-quotes-returns ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 3, 2024 6:22pm
vercel[bot] commented 3 weeks ago

@marceloams is attempting to deploy a commit to the shravan20's projects Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes in this pull request introduce a customizable border color feature for quote templates. The README.md file has been updated to document this new functionality, allowing users to specify a border color using the ?borderColor=COLOR parameter. The quotesController, quotesService, and Template class have been modified to support this new property. Additionally, the default layout's CSS has been updated to utilize the dynamic border color. Overall, these changes enhance the customization options for quote templates.

Changes

File Change Summary
README.md Added documentation for ?borderColor=COLOR feature and restructured quote category instructions.
src/api/controllers/quotesController.js Added borderColor property to quoteObject based on query parameter.
src/api/services/quotesService.js Added borderColor parameter to getQuote function and utilized it in setting the template's border color.
src/layouts/layout.js Updated default layout's CSS to use dynamic borderColor.
src/models/Template.js Introduced setBorderColor method in Template class to set border color.

Assessment against linked issues

Objective Addressed Explanation
Add customizable border color option to default layout (#332) ✅

Possibly related PRs

Suggested reviewers

Poem

In a world of quotes, bright and bold,
A border's hue, a story told.
With colors to choose, oh what a sight,
Customization brings pure delight!
So set your shade, let your voice be heard,
In every quote, let your heart be stirred! 🐇✨

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 8ed21011ec7f6d04b3b56cddbbc69d57f5149d1f and 7d4b15f2a1e3cc91af3b11a74dcf1afbee1f6dba.
📒 Files selected for processing (1) * `README.md` (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * README.md

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.