Skip to content

Conversation

@rajghosh06-dev
Copy link
Contributor

Summary

This PR addresses two documentation and onboarding improvements:

  1. README.md

    • Fixed typo: applicaiton/yamlapplication/yaml
    • Reworded paragraph under “Known Issues” for clarity and consistency
    • Updated variable name from clust_id to cluster_id to match usage elsewhere in README
  2. tests/integration/defaults.py

    • Added inline comments for each environ.get() usage
    • Clarified which environment variables can override default test values
    • Improves onboarding and test customization clarity

Motivation

This pull request improves clarity and avoids redundancy by removing duplicate “what is this” sections across multiple files and tightening paragraph spacing for better readability.

- Corrected 'applicaiton/yaml' to 'application/yaml'
- Reworded paragraph for clarity and consistency
- Updated variable name from 'clust_id' to 'cluster_id' to match usage elsewhere in README
- Documented each overrideable default using consistent, concise comments
- Improved onboarding clarity for contributors customizing integration tests
@rajghosh06-dev
Copy link
Contributor Author

Hi @digitalocean-maintainers!
This PR improves clarity in the README and adds inline comments to support onboarding in defaults.py. Let me know if any adjustments are needed—happy to iterate.
Thanks for maintaining such a welcoming and well-documented repo!

Copy link
Contributor

@DO-rrao DO-rrao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for your contribution!

@DO-rrao DO-rrao merged commit 145bfc7 into digitalocean:main Jan 6, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants