smartcontractkit / smartcontractkit/chainlink
[DEVEL] Documentation and Configuration Mismatches in Test Scripts
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 8.2k
- Forks
- 2k
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 202
Description
Documentation and Configuration Mismatches in Test Scripts
Description
Some test scripts reference outdated or incorrect documentation/configuration, leading to confusion or misconfiguration during test runs. Keeping documentation and configuration in sync is essential for reliable testing.
Environment
- Chainlink repo: develop branch
- Go 1.22+
- OS: Linux 6.11.0-29-generic
Examples
integration-tests/README.md: Mentions scripts or flags that no longer exist.core/scripts/ccip/ccip_script.go: References deprecated environment variables.
Steps to Reproduce
- Compare documentation with actual scripts and configuration files.
- Attempt to follow documented steps and note discrepancies.
Additional Info
- Update documentation when scripts/configuration change.
- Remove references to deprecated flags or variables.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare integration-tests/README.md with the scripts and flags it documents, then inspect core/scripts/ccip/ccip_script.go for deprecated environment variables. Follow the documented test steps to confirm each discrepancy. Done means the documentation matches the current scripts and configuration, with obsolete flags and variables removed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation, testing-qa
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100