ESCOMP / ESCOMP/CTSM

Stop doing vertical alignment in our code for new PR's

Open
#2,144 0 comments 0 reactions 0 assignees View on GitHub
code health priority: low
Dominant language
Fortran
Stars
352
Forks
361
Avg merge
6d 6h
Merged PRs (30d)
8

Description

We've made it a standard in CTSM to vertically align code blocks, which makes it easier to read because of how human eyes work. This is especially useful for basic editors that don't have syntax highlighting. However, it takes effort to maintain and can make merges more complex. Especially if this is done by hand. Some developers have tools that do this for them, but not all. As such we've decided to move away from this practice. For now this means that new PR's should NOT make changes to vertical alignment.

Here's articles with the pro and con:

[Pro](https://shkspr.mobi/blog/2014/11/why-i-vertically-align-my-code-and-you-should-too/); [con](http://missingbytes.blogspot.com/2014/11/why-he-vertically-aligns-his-code-and.html)

Definition of Done:
- [ ] Add a note about this to our PR template
- [ ] Change the developers Guide to note this

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.