Apply small README improvements #266
Conversation
README.md
Outdated
| @@ -139,10 +139,11 @@ Two things are kicking in here: | |||
| Be sure to check out all [bug checks][bug-checks] and [refaster | |||
| templates][refaster-templates]. | |||
|
|
|||
| ## 👷 Building | |||
| ## 👷 Building Error Prone Support | |||
There was a problem hiding this comment.
Why would we like to repeat the project's name? If it's preferred, should we also update below? e.g. How Error Prone Support works?
There was a problem hiding this comment.
As mentioned in Slack:
.. to clearly indicate we're switching from showing the tool in action (section above) to talking about the project itself.
On my first read, it seemed like the Building section was still about the example that is explained just above. Instead, we switch to documentation about the project itself. Open to other suggestions to make this distinction clearer.
There was a problem hiding this comment.
It's already an H1 (along with a nice emoji), so that should conceptually separate it.
However, I do see your point.
Alternatives:
Developing Error Prone Support, similar to https://github.com/google/error-proneBuilding locallyRunning Error Prone Support locally
There was a problem hiding this comment.
ps. if changing, we need to update the anchor (line 23)
There was a problem hiding this comment.
I like Developing Error Prone Support, will update. Including anchor, good point.
Stephan202
force-pushed
the
sandermak/readme-updates
branch
from
f7091bf to
313ce8a
Compare
README.md
Outdated
| Error Prone Support is a [Picnic][picnic-blog]-opinionated extension of Google's | ||
| [Error Prone][error-prone-orig-repo]. It aims to improve code quality, focussing | ||
| on maintainability, consistency and avoidance of common pitfalls. |
There was a problem hiding this comment.
Wrapping, whitespace at end of lines 👀
No description provided.