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

Upgrade 06-best-practices with more references or even practices? #421

Draft
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
3 participants
@katrinleinweber
Copy link
Collaborator

commented Apr 23, 2019

Besides, this PR drafts & discusses a few related upgrades, namely suggestsions to include more references to enable learners to read more about the reasonin behind each item we suggest. I think we should avoid including more suggestions, unless they are short and backed by references.

My goal here is to:

  • suggest references for the existing best practices

to exemplify the above.

Group advice about commenting options together
Also rephrase & specify references, because comments & Git commit messages may be technically different, but are semantically similar, because they exist for the same purpose: (re)understanding existing code.
@Afrah-Khairallah

This comment has been minimized.

@katrinleinweber

This comment has been minimized.

Copy link
Collaborator Author

commented Apr 24, 2019

I think we should either be a bit more specific, linking each of our items to another resource, or agree to replace our list with a particular resource or list.

@diyadas

This comment has been minimized.

Copy link
Collaborator

commented Apr 29, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.