JacquesCarette / Drasil

Generate all the things (focusing on research software)
https://jacquescarette.github.io/Drasil
BSD 2-Clause "Simplified" License
142 stars 26 forks source link

Contributor's Guide Further Update #3806

Open daijingz opened 3 months ago

daijingz commented 3 months ago

Previously there was an issue with inserting commit message guidance into the contributor's guide. This inspires me, as there is a possible improvement in the contributor's guide:

3f26aaf4425718800bc013105011444d 1e8814232dd30ff7c2709a248387b72c

In the first situation, the definition has left different amounts' spacings in order to bring the same indentation level to the operator =, while the second situation only allows one space between different things. These are two different indentations.

In the previous issues, I did not know which case we should use the first situation, and which case we should use the second situation. I did not find useful information in the contributor's guide.

@JacquesCarette, I feel some requirements become invisible or ambiguous. Sometimes I do not know some requirements, and sometimes there are collisions between different requirements. (Similar as conflicts)

There is something I want to improve:

  1. Insert an information field inside "Coding Style", to include information about definition spacing. (There are many different cases for spacing, each case should be summarized into requirements, and should include a good example inside for each case)

MORE Points are coming.

JacquesCarette commented 3 months ago

Lining up certain definitions is indeed a good idea.