Readme.md: Heading capitalization and some cleanup #2881
Conversation
|
I'd have thouhgt it'd be best to normalize NOT having capitals in the middle of sentences... We're not marketers :/ |
|
@moneromooo-monero That said, the Bitcoin github capitalizes every word like we do. So there is precedent to keep things this way. Shall I switch the readme to just having the first word capitalized? |
|
Meh, it's a fairly common way to do it too, so I don't really care all that much. The bitcoin github isn't a particularly authoritative model for something like this fwiw. |
|
Edited with just first word capitalized. Let me know what you think. |
|
A few suggestions:
|
|
I personally prefer the new cap format, thanks :) The second VRP paragraph seems entirely redundant indeed. The long title is gingeropolous' construction, convince him :) |
|
I don't care what the title is, as long as its just not "hard fork". I like the current title, obviously, because it explains things better than "hard fork". perhaps it can just be "Network Consensus Protocol Upgrade " and we can move "Software updates" into the title below. |
|
Edited. Hopefully this looks good. |
ghost
changed the title
README.md
Outdated
|
|
||
| - Our [Vulnerability Response Process](https://github.com/monero-project/meta/blob/master/VULNERABILITY_RESPONSE_PROCESS.md) encourages responsible disclosure | ||
| - Our [vulnerability response process](https://github.com/monero-project/meta/blob/master/VULNERABILITY_RESPONSE_PROCESS.md) encourages responsible disclosure |
There was a problem hiding this comment.
The VRP (and the adjectives which define the process) are defined as a proper noun. As such, the caps should stay.
|
I don’t think there has been enough discussion to merge this one. We need at least 50 comments for a change this big. |
|
I don't really care, but I don't like "Network Consensus Protocol Upgrade" over hard fork, because the network protocol doesn't seem to affect consensus at all. |
|
well it aint my fault bitcoin poisoned the notion of a hard fork. aight then, Blockchain Inclusion Consensus Upgrade ... because it does change what is considered valid to be entered into the block. whose riding dem bikes? |
|
I like "hard fork". |
|
I prefer the heading be similar: Hard fork schedule |
|
I prefer hard fork.. :) |
|
aight, then you guys get to do all the explaining on reddit :) |
|
Fwiw, I used |
|
After some discussion, people seem to agree on "Scheduled mandatory software upgrades" as the ideal heading for the section about scheduled hard forks. See recent commit and this discussion: https://paste.fedoraproject.org/paste/B~KljNfTRe1i2XFS0BgMFA See the Readme in full @ https://github.com/xmr-eric/monero/tree/patch-4 |
Recently the GUI repo had its name changed from monero-core to monero-gui. This PR updates the build instructions and elsewhere with the new repo name and link. This PR also seeks to put the heading capitalization policy inline with the main Monero readme. Capitalizing every single word in a heading begins to feel redundant and cumbersome when headings become long (and many are indeed quite long). A much better practice is capitalizing just the initial word. See: monero-project/monero#2881
41fc11f Scheduled mandatory software upgrades (xmr-eric) 3b5382f Keep VRP a proper noun (xmr-eric) 7160cbd CONTRIBUTING.md capitalization (xmr-eric) f36ffc0 Shorten a title, remove a section, small edits (xmr-eric) 0017991 Capitalization on first word only (xmr-eric) 6ffae07 Readme.md: Normalize heading capitalization (xmr-eric)
Most headings capitalized every word. A few did not. Now all do.