Add note about referral links

jesserockz commented 3 weeks ago

Description:

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable): esphome/esphome#

Checklist:

[ ] I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
or
[ ] I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.
[ ] Link added in /index.rst when creating new documents for new components or cookbook.

netlify[bot] commented 3 weeks ago

Deploy Preview for esphome ready!

Name	Link
Latest commit	eaae65ee52057ea196f31bd83fc3a841e7aa1f60
Latest deploy log	https://app.netlify.com/sites/esphome/deploys/6732cf5ad0f9020008eb3b51
Deploy Preview	https://deploy-preview-4431--esphome.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] commented 3 weeks ago

Deploy Preview for esphome ready!

Name	Link
Latest commit	30cf88f0a708dcbcfbf48d902741cd11f03cc225
Latest deploy log	https://app.netlify.com/sites/esphome/deploys/6732d0fe7680630008e8e2c5
Deploy Preview	https://deploy-preview-4431--esphome.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The pull request introduces enhancements to the guides/contributing.rst file for the ESPHome project. Key changes include the addition of a new section titled "Contributing Links," which specifies that referral links are prohibited unless they directly benefit the project. Additional notes have been incorporated to clarify expectations regarding tests, image optimization, and formatting standards for contributions. These modifications aim to improve the clarity and comprehensiveness of the contribution guidelines.

Changes

File	Change Summary
guides/contributing.rst	- Added a new section "Contributing Links" prohibiting referral links unless they benefit the project. - Added notes on passing tests, image optimization, and formatting standards for contributions.

Possibly related PRs

#4229: This PR also modifies the guides/contributing.rst file, enhancing the contributing guidelines with new sections and clarifications, similar to the changes made in the main PR.
#4359: This PR adds examples of collapsible sections and tabs to the guides/contributing.rst file, which is directly related to improving the structure and clarity of the contribution guidelines, aligning with the objectives of the main PR.
#4372: This PR introduces several modifications to the guides/contributing.rst file, enhancing the clarity and structure of the contribution guidelines, which relates closely to the changes made in the main PR.

Suggested reviewers

kbx81

📜 Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

📥 Commits

Reviewing files that changed from the base of the PR and between f4226cb93a02f43edfe934290b75ec95813e20ee and 30cf88f0a708dcbcfbf48d902741cd11f03cc225.

📒 Files selected for processing (1)

* `guides/contributing.rst` (4 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

guides/contributing.rst (1)

Pattern `**`: - Do not generate or add any sequence diagrams

🔇 Additional comments (4)

guides/contributing.rst (4)

`197-198`: **LGTM: New section header follows RST syntax guidelines** The addition of the "Contributing Links" section with proper reference label is well-structured. --- `208-212`: **LGTM: Clear policy statement about referral links** The note about referral links is well-formatted and provides clear guidance about the project's policy. --- `505-505`: **LGTM: Helpful image optimization command** The added imagemagick command provides a useful tool for contributors to optimize their images. --- `1036-1036`: **LGTM: Clarification about external components** The added clarification about YAML configuration for external components enhances the documentation.

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.

esphome / esphome-docs