Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contributor's Guide Further Update #3806

Open
daijingz opened this issue Jun 16, 2024 · 1 comment
Open

Contributor's Guide Further Update #3806

daijingz opened this issue Jun 16, 2024 · 1 comment

Comments

@daijingz
Copy link
Contributor

daijingz commented Jun 16, 2024

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.

@daijingz daijingz changed the title Contributor's Guide Further Update: Contributor's Guide Further Update Jun 16, 2024
@JacquesCarette
Copy link
Owner

Lining up certain definitions is indeed a good idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants