sebinbenjamin / image-res-generator

A versatile tool for generating icons and splash screens for web and mobile projects. Supports Angular, Ionic, PWA, and more, with seamless SVG and PNG resource generation.
GNU General Public License v3.0
8 stars 5 forks source link

Improve code standards by enforcing ESLint, using Husky + conventional commits and PR templates #10

Closed sebinbenjamin closed 5 years ago

sebinbenjamin commented 5 years ago

Description

Following changes are brought in this PR.

Related Issue

Fixes #4, fixes #5, fixes #7

Motivation and Context

ESLint helps to achieve clear consistent coding conventions, with automated enforcement. Linters are also excellent tools for finding certain bugs, bad practices and outdated language features.

Husky provides an easy way to add Git hooks to execute ESLint before committing code. This ensures that commits don't violate ESLint rules.

A contribution guide provides potential project contributors with a short guide to how they can help with your project, making things clear and enabling quicker, hassle-free contributions.

How Has This Been Tested?

Manually tested to verify output generation.

Types of changes

Checklist: