Knockout-Contrib/Knockout-Validation

Consistent coding style suggestions

Open

#488 opened on Dec 23, 2014

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (1,024 stars) (394 forks)batch import
help wanted

Description

I'm considering making some changes which should help us have a more maintainable and uniform source code. Here's what I have in mind:

  • make all directories lowercase (Dist -> dist, Src -> src)
  • ensure consistent coding style using http://editorconfig.org/
  • use spaces instead of tabs - e.g. gruntfile looks really bad when open in Github
  • add more JSHint rules

Although it's not critical to implement this right now, I want to have some feedback before going further. I would prefer to have this pushed to v2 release since we have a lot of changes since last release and it would be a good time for it - v2 release notes here.

Feel free to share your ideas to make this project better.

Contributor guide

Tech stack
javascriptnodejs
Domain
developer experiencetooling
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of Knockout JSFamiliarity with grunt
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
The issue proposes several coding style improvements like renaming directories to lowercase, adding EditorConfig, enforcing spaces instead of tabs, and adding JSHint rules. Check the comments for any feedback from maintainers or contributors. Since the issue is from 2014 and no linked PR exists, it may be stale. Investigate if the maintainers still plan to implement these changes for v2 or if they have been addressed elsewhere.