Many people think of “coding standards” in a trivial way—i.e. minutae such as how many spaces to indent, or whether you place the close-curly-brace on a new line by itself.
I, on the other hand, think that if you can only implement one software engineering technique to improve quality, it should be coding standards. Indeed, I believe some coding standards can actually help you learn a programming language. Do you agree?
After your first week of using ESLint with VSCode, what are your impressions? Are you finding that getting rid of all the ESLint errors is painful, or useful, or both, or something else entirely?
Write an interesting, informative essay on coding standards that addresses some or all of the above questions, or goes in a different direction entirely regarding coding standards. Make sure it provides your personal perspective and useful insights.
By the time and date indicated on the Schedule page, write a technical essay regarding this module. You can use the issues above as a starting point, but write a stand-alone essay: don’t just answer them like it’s a homework assignment! Once you’ve finished the essay submit it using Laulima.
Please note the following:
Your submission should be a URL providing a direct link to your (HTML formatted) essay contained within your professional portfolio website (not a link to the home page of your portfolio website, not a link to the essays directory page of your website, not a link to the markdown source or a google doc or a PDF etc). Here’s an example of an acceptable URL: https://philipmjohnson.org/essays/kahala-challenge.html. Here’s an example of an unacceptable URL: https://github.com/philipmjohnson/philipmjohnson.github.io/blob/main/essays/kahala-challenge.md. If the link does not work, you will not get credit for your essay.
An entry for your essay must also appear in the Essays page of your portfolio. Check this before submission. If it is not listed, it’s probably because your YAML front matter is incorrect. See the Essay Content section of the TechFolio documentation for details.
Be sure that your essay is ready for evaluation before submitting it via Laulima. I often click on the link as soon as I receive the submission. If the essay is empty or only partially complete when I click on the link, you might not receive credit.
Your essay must be original content, written during this semester reflecting your current views and writing style. You cannot submit essays that you wrote previously for this assignment. The purpose of this assignment is for you to practice writing right now, this semester.
If you use ChatGPT or other AI to support your writing, you must attribute the way you used it. Note that using AI to write your assignment, rather than assist with grammar and so forth, is unlikely to result in a good essay that reflects your “voice”. If you use AI to write your essay and do not indicate this in the essay itself or in the submission form, you will receive a zero for the assignment.
[ ] Name the essay file according to its subject.
[ ] Create an interesting title that draws in the reader.
[ ] Use appropriate spelling and grammar.
[ ] Write for the world, not the professor.
[ ] Format code appropriately.
[ ] Use internal headings to structure your essay.
[ ] Format and attribute quotations.
[ ] Include pictures or other media.
[ ] Don’t be boring, don’t be inappropriate.
[ ] Review your post’s content and appearance.
[ ] One paragraph is not enough.
[ ] Indicate that you used AI or discuss use of AI in essay.