Add Code Style #277
Merged
Add Code Style #277
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
veger
approved these changes
Sep 8, 2024
DaleStan
approved these changes
Sep 9, 2024
The ReleaseAlgorithm.md is not used because there are convenient reminders in /build.sh. If this project is later forked by someone else, the chances of ReleaseAlgorithm.md being useful are close to zero.
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.
Problem: The Contributors Guide started to feel bloated from the code suggestions.
Solution:
Put code suggestions into a separate page.
While at it, add a thing that I think will make the project more readable -- blank lines around code blocks when reasonable.
Also clean up some other
.mdfiles in a separate commit.The main change from the previous code style is the Blank Lines section. The rest is mostly the rewording of the info that we already had or applied.