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

Update coding style doc #215

Open
1 of 3 tasks
ned21 opened this issue Mar 30, 2017 · 0 comments
Open
1 of 3 tasks

Update coding style doc #215

ned21 opened this issue Mar 30, 2017 · 0 comments
Milestone

Comments

@ned21
Copy link
Contributor

ned21 commented Mar 30, 2017

The coding style should be updated to reflect even more modern practices:

  • use constant => Readonly
  • Section "Be modular" talks about number of local variables, etc. Ideally it should be replaced with a mandate to make code unit testable since that tends to inherently force modularity. Readers interested in measures of technical complexity should be referred to read "Code Complete 2" instead!
  • Add a section on writing good commit logs which should document the intent (or "why") of the change
@jrha jrha added this to the 25.next milestone Sep 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants