WordPress / WordPress/secure-custom-fields
Release management: automatically tag `@since` annotations with the correct version
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 131
- Forks
- 64
- Avg merge
- 10m
- Merged PRs (30d)
- 1
Description
As of SCF 6.4, every time we add a new APi, we need to manually add the specific version @since annotation, which can lead to inaccuracies: if there is a new release before the branch with the new API is merged, its @since annotations need to be updated.
SCF should have a placeholder like {NEXT_MAJOR_VERSION} that gets replaced with the appropriate version during the release process jobs, so that contributors just need to type @since {NEXT_MAJOR_VERSION}.
Contributor guide
No contributing guide indexed for this repository
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
Start by tracing the release process jobs and how the project determines its next version. Identify where @since {NEXT_MAJOR_VERSION} annotations could be replaced during release, then verify that contributors can use the placeholder and that released API annotations contain the appropriate version.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- release
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100