Knockout-Contrib / Knockout-Contrib/Knockout-Validation

Consistent coding style suggestions

Open
#488 4 comments 0 reactions 0 assignees View on GitHub
help wanted
Dominant language
JavaScript
Stars
1k
Forks
366
PR merge metrics
No merged PRs in 30d

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](https://raw.githubusercontent.com/Knockout-Contrib/Knockout-Validation/master/gruntfile.js) 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](469).

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

Contributor guide

Open the contributing guide

Research direction

Review the proposed directory renames, gruntfile.js formatting, EditorConfig adoption, and additional JSHint rules, along with the linked v2 release notes. The issue does not define a specific scope or completion criterion, so the first step is to clarify which changes belong in the work and how consistency will be verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.