Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Update documentation to better explain `@wip` tag

Open
#182 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Start with docs/source/development.rst and README.rst, then read gherkinize.py to understand how cel-spec test data becomes the features directory tree and receives @wip tags. Update the Development Tools explanation and add a README link; the complete feature-list page is already marked complete by #191. Done means both documentation paths clearly explain the flow and link correctly.

Written by the indexing model from the issue text.

Description

documentation enhancement tracking

Three related changes to the documentation.

  • Update the Development Tools section (docs/source/development.rst) to include an explanation of the @wip tag, and how the test data flows from cel-spec to the features directory tree with tags injected by the gherkinize.py tool.

  • Add a link to this to the README.rst to provide a clear path to show how @wip tags are injected into the tests.

  • Add a page with the complete list of features, showing ✅ and ❌ for the features supported and the features marked @wip. (It's not clear precisely how to do this. It might be an useful secondary output from the gherkinize.py tool.) Completed by #191

Dominant language
Python
Stars
174
Forks
40
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cloud-custodian/cel-python

All issues in cloud-custodian/cel-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.