clarify the purpose of this repo#1189
Open
aelmanaa wants to merge 1 commit into
Open
Conversation
|
👋 aelmanaa, thanks for creating this pull request! To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team. Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks! |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a prominent top-of-README notice clarifying that this repository is intended for source review/testing/experimentation (not third-party CCV operator onboarding) and summarizing the repository’s licensing split.
Changes:
- Added an
[!IMPORTANT]notice at the top ofREADME.mddescribing intended usage and support expectations. - Added licensing guidance pointing readers to
LICENSEand summarizing which directories are BSL 1.1 (until the change date) vs MIT.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+4
to
+8
| > This repository contains CCV protocol source code and internal development tooling. It is public for source review, testing, forks, and independent experiments. It is not a supported starter kit, deployment package, or onboarding path for third-party CCV operators. | ||
| > | ||
| > For CCV operator onboarding, use the CCV starter kit and operator documentation when they are available, or work with your Chainlink Labs contact. | ||
| > | ||
| > See [`LICENSE`](./LICENSE) before using this code. The `aggregator`, `indexer`, `protocol`, `common`, `deployment`, `build`, and `chains` directories are under Business Source License 1.1 until Jan 1, 2030, then MIT. Other content is MIT. |
|
Code coverage report:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request adds an important notice to the
README.mdto clarify the intended use and licensing of the repository. The new section makes it clear that this repository is not a starter kit or onboarding path for third-party CCV operators and provides guidance for proper onboarding and licensing.Documentation updates:
README.mdstating that the repository is for source review, testing, and experimentation, not for third-party operator onboarding, and included licensing details for various directories.