make minor formatting changes to docs
This commit is contained in:
parent
ff6ddd1f13
commit
027a119f84
|
@ -1,7 +1,8 @@
|
||||||
# 🥳 ==> 🧼 ==> 😇
|
# 🥳 ==> 🧼 ==> 😇
|
||||||
**ephemetoot** is a Python command line tool for deleting old toots.
|
|
||||||
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
|
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
|
||||||
|
|
||||||
|
**ephemetoot** is a Python command line tool for deleting old toots.
|
||||||
|
|
||||||
# Prior work
|
# Prior work
|
||||||
The initial `ephemetoot` script was based on [this tweet-deleting script](https://gist.github.com/flesueur/bcb2d9185b64c5191915d860ad19f23f) by [@flesueur](https://github.com/flesueur)
|
The initial `ephemetoot` script was based on [this tweet-deleting script](https://gist.github.com/flesueur/bcb2d9185b64c5191915d860ad19f23f) by [@flesueur](https://github.com/flesueur)
|
||||||
|
|
||||||
|
@ -242,7 +243,7 @@ rm ~/Library/LaunchAgents/ephemetoot.scheduler.plist
|
||||||
|
|
||||||
# Contributing
|
# Contributing
|
||||||
|
|
||||||
For all bugs, suggestions, pull requests or other contributions, please check the [contributing guide](./CONTRIBUTING.md).
|
For all bugs, suggestions, pull requests or other contributions, please check the [contributing guide](./contributing.md).
|
||||||
|
|
||||||
# License
|
# License
|
||||||
|
|
||||||
|
|
|
@ -30,7 +30,7 @@ Each issue should refer to a single bug or enhancement. Don't include multiple s
|
||||||
- "Ephemetoot may die when encountering utf8 encoded toots" ([bug](https://github.com/hughrun/ephemetoot/issues/11))
|
- "Ephemetoot may die when encountering utf8 encoded toots" ([bug](https://github.com/hughrun/ephemetoot/issues/11))
|
||||||
- "Optionally include datetime stamp with every action" ([enhancement](https://github.com/hughrun/ephemetoot/issues/23))
|
- "Optionally include datetime stamp with every action" ([enhancement](https://github.com/hughrun/ephemetoot/issues/23))
|
||||||
|
|
||||||
**Commit messages** should start with an [imperative verb](https://www.grammarly.com/blog/imperative-verbs/). Simple commits such as documentation fixes may only need a brief sentence. Something bigger like an enhancement should usually have a commit heading briefly describing the outcome of the commit, with a longer explanation underneath. Past examples of good commit titles are:
|
**Commit and pull request messages** should start with an [imperative verb](https://www.grammarly.com/blog/imperative-verbs/). Simple commits such as documentation fixes may only need a brief sentence. Something bigger like an enhancement should usually have a heading briefly describing the outcome of the commit, with a longer explanation underneath. Past examples of good commit titles are:
|
||||||
|
|
||||||
- "handle IndexError when there are no toots in the timeline" ([bugfix](https://github.com/hughrun/ephemetoot/commit/92643271d53e00089a10bacd1795cfd50e030413))
|
- "handle IndexError when there are no toots in the timeline" ([bugfix](https://github.com/hughrun/ephemetoot/commit/92643271d53e00089a10bacd1795cfd50e030413))
|
||||||
- "add support for archiving toots into JSON files" ([new feature](https://github.com/hughrun/ephemetoot/commit/c0d680258ff0fe141fbabcf14a60eee8994e8d18))
|
- "add support for archiving toots into JSON files" ([new feature](https://github.com/hughrun/ephemetoot/commit/c0d680258ff0fe141fbabcf14a60eee8994e8d18))
|
||||||
|
|
Loading…
Reference in New Issue