hiro/releases
1
0
Fork 0
mirror of https://github.com/vale981/releases synced 2025-03-05 09:41:42 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #2 from keimlink/fix-README-typos

Browse source 
Fixed a few typos.
This commit is contained in:
Jeff Forcier 2013-09-24 19:03:47 -07:00
commit e2cedc0488
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.rst
View file

@ -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 * Create a docs file named ``changelog.rst`` with a top-level header followed
by a bulleted list. by a bulleted list.
* Bullet list items must use the ``:support:``, ``:feature`` or ``:bug`` roles to * Bullet list items must use the ``:support:``, ``:feature:`` or ``:bug:``
mark issues, or ``:release:`` to mark a release. These special roles must be roles to mark issues, or ``:release:`` to mark a release. These special roles
the first element in each list item. must be the first element in each list item.
* Issue roles are of the form ``:type:`number[ keyword]```. Keywords are * Issue roles are of the form ``:type:`number[ keyword]```. Keywords are
optional and may be one of: optional and may be one of:
@ -101,8 +101,8 @@ TODO
entry is not (IMHO) acceptable. entry is not (IMHO) acceptable.
* Possibly add more keywords to allow control over additional edge cases. * Possibly add more keywords to allow control over additional edge cases.
* Add shortcut format option for the release/issue URI settings - Github users * 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. 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 * 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 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.) feature-vs-bugfix releases pre-1.0? (which is common.)