Skip to content
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

update root shields #1117

Merged
merged 4 commits into from
Sep 4, 2024
Merged

update root shields #1117

merged 4 commits into from
Sep 4, 2024

Conversation

skudasov
Copy link
Collaborator

@skudasov skudasov commented Sep 4, 2024


Below is a summarization created by an LLM (gpt-4-0125-preview). Be mindful of hallucinations and verify accuracy.

Why

The changes made to the README.md files in both the root and the lib directory reflect an effort to reorganize and clarify the documentation related to the Chainlink Testing Framework. By introducing specific tags for different libraries such as WASP, Seth, and Havoc, and adjusting the way Go versions are displayed, the project aims to make it easier for developers to find and utilize specific components of the testing framework. The major cleanup in the main README.md indicates a shift towards a more streamlined presentation of available tools and functionalities, possibly in response to the evolution of the project's scope or user feedback.

What

  • README.md
    • Updated badge links to filter by library-specific tags (Lib, WASP, Seth, Havoc), making it easier to track version updates for different parts of the project.
    • Changed the Go reference badge URL to point directly to the lib directory, ensuring users are guided to the most relevant package information.
    • Streamlined the content by removing detailed sections about Kubernetes (k8s) package usage, local cluster setup, testing in k8s, etc., focusing instead on the core features and libraries provided by the testing framework.
    • Removed sections related to Chainlink Charts, Simulated EVM Chains, LogStream package, TOML Config, ECR Mirror, and debugging tips, indicating a significant restructuring of the documentation to possibly enhance readability and maintain focus on the primary features.
  • lib/README.md
    • Changed the title from "Chainlink Testing Framework" to "Framework", simplifying the context to focus on the library aspect.
    • Updated badges for consistency with the main README.md changes, including the filtered Lib tag and the specific Go version file reference.
    • Refined the purpose of the framework, now highlighting its capabilities in terms of interacting with blockchains, configuring Chainlink jobs, and deploying using Docker or Kubernetes, presenting a concise overview of what users can achieve with the library.

@cl-sonarqube-production
Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@skudasov skudasov marked this pull request as ready for review September 4, 2024 14:58
@skudasov skudasov requested review from sebawo and a team as code owners September 4, 2024 14:58
@skudasov skudasov merged commit 3206eca into main Sep 4, 2024
45 checks passed
@skudasov skudasov deleted the update-badges branch September 4, 2024 14:59
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.

2 participants