tarantool / tarantool/tarantool
Add more checks to tools/gen-release-notes
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 3.7k
- Forks
- 419
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 88
Description
-
Check that only known section names are used to avoid section naming mess:
https://github.com/tarantool/tarantool/blob/a303b53beb1cd752816a7f1991235dab8a091569/changelogs/unreleased/gh-4861-net-box-return-raw.md?plain=1#L1 -
Check for indentation:
- Bad alignment
https://github.com/tarantool/tarantool/blob/a303b53beb1cd752816a7f1991235dab8a091569/changelogs/unreleased/gh-4415-introduce-decimal.md?plain=1#L1-L4 - Extra space before *
https://github.com/tarantool/tarantool/blob/a303b53beb1cd752816a7f1991235dab8a091569/changelogs/unreleased/add-check-for-user-input-of-the-number-of-iproto-threads.md?plain=1#L1-L3
- Bad alignment
-
Check for long lines:
https://github.com/tarantool/tarantool/blob/a303b53beb1cd752816a7f1991235dab8a091569/changelogs/unreleased/gh-5799-add-info-to-fiber-object.md?plain=1#L3
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
Start with tools/gen-release-notes and compare its current validation with the linked changelog examples. Add checks for known section names, indentation, and long lines, then verify that the reported examples are rejected while correctly formatted release notes remain accepted.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- release
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100