Skip to content

Conversation

@bhazuka
Copy link

@bhazuka bhazuka commented Dec 23, 2025

Summary: Summary of changes

Addresses CUMULUS-4436: Update Cumulus documentation on Python and tasks

Changes

  • Created new file docs/development/python-best-practices.md to capture Python language expectations, tooling, and standards.
  • Created new file docs/development/typescript-best-practices.md to capture Typescript language expectations, tooling and standards. Content from this was pulled from various cumulus docs.
  • Modified docs/development/quality-and-coverage.md file to reference the "best practice language docs" and provide a higher level repo management explanation of tooling and usage.
  • Modified docs/adding-a-task.md to provide overview and expectations for creating a task.
  • Modified website/sidebar.js to include new "best practices" documents.

PR Checklist

  • Update CHANGELOG
  • Unit tests (N/A)
  • Ad-hoc testing - Deploy changes and test manually (Tested via Docusarus local build and visual verification)
  • Integration tests (N/A)

📝 Note:
For most pull requests, please Squash and merge to maintain a clean and readable commit history.

…and updated adding-a-task and quality-and-coverage information to documentation.
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