Contributing.md: Minor re-organization of headings #5017
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
reviewed
Mar 5, 2017
| @@ -29,7 +26,7 @@ Following this guide and formatting your code as detailed will likely get your p | |||
| This project uses clang-format (stable branch) to check for common style issues. In case of conflicts between this guide and clang-format rules, the latter should be followed instead of this guide. | |||
|
|
|||
|
|
|||
| ### Checking and fixing formatting issues | |||
| ## <a name="intro-formatting-issues"></a>Checking and fixing formatting issues | |||
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
This gives headings consistent link references that won't arbitrarily change if the text representing it does, which makes for better organization. This is also less error-prone when it comes to specifying links in the presence of two headings with the same text content, but under different sections. This also treats each section and sub-section such that they all have their own dividers.
|
Can't |
|
If it were XML, yes. HTML doesn't allow short-tags there. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This gives headings consistent link references that won't arbitrarily change if the text representing it does, which makes for better organization. This is also less error-prone when it comes to specifying links in the presence of two headings with the same text content, but under different sections. This also treats each section and sub-section such that they all have their own dividers.
This also clearly distinguishes the current coding style and guidelines as applicable to our C++ code. This makes including specific guidelines for other languages or tooling less ambiguous (e.g. If CMake were to get a preferred style/formatting for our codebase, "C++ Coding Style and Formatting" and "CMake Coding Style and Formatting" are less ambiguous compared to "Styling and formatting" and "CMake Coding Style and Formatting").
Ideally, I'd like to eventually drop the bulleted list style that our guidelines currently have and make proper linkable sections for them along with adding rationales/explanations to each guideline where applicable.