mirror of
https://github.com/vale981/releases
synced 2025-03-04 17:21:43 -05:00
Merge pull request #2 from keimlink/fix-README-typos
Fixed a few typos.
This commit is contained in:
commit
e2cedc0488
1 changed files with 5 additions and 5 deletions
10
README.rst
10
README.rst
|
@ -42,9 +42,9 @@ Mimic the format seen `in Fabric's changelog
|
|||
|
||||
* Create a docs file named ``changelog.rst`` with a top-level header followed
|
||||
by a bulleted list.
|
||||
* Bullet list items must use the ``:support:``, ``:feature`` or ``:bug`` roles to
|
||||
mark issues, or ``:release:`` to mark a release. These special roles must be
|
||||
the first element in each list item.
|
||||
* Bullet list items must use the ``:support:``, ``:feature:`` or ``:bug:``
|
||||
roles to mark issues, or ``:release:`` to mark a release. These special roles
|
||||
must be the first element in each list item.
|
||||
* Issue roles are of the form ``:type:`number[ keyword]```. Keywords are
|
||||
optional and may be one of:
|
||||
|
||||
|
@ -101,8 +101,8 @@ TODO
|
|||
entry is not (IMHO) acceptable.
|
||||
|
||||
* Possibly add more keywords to allow control over additional edge cases.
|
||||
* Add shortcut format option for the release/issue URI settings - Github users
|
||||
can just give their Github acct/repo and we will fill in the rest.
|
||||
* Add shortcut format option for the release/issue URI settings - GitHub users
|
||||
can just give their GitHub acct/repo and we will fill in the rest.
|
||||
* Maybe say pre-1.0 releases consider all bugs 'major' (so one can e.g. put out
|
||||
an 0.4.0 which is all bugfixes). Iffy because what if you *wanted* regular
|
||||
feature-vs-bugfix releases pre-1.0? (which is common.)
|
||||
|
|
Loading…
Add table
Reference in a new issue