hackforla / hackforla/lucky-parking

[Tech Debt] Consider and implement editor configuration file

Open
#532 1 comment 0 reactions 1 assignee Claimed by @glenflorendo View on GitHub
complexity: medium feature: refactor missing: milestone role: dev size: 2pt temp: engineering board move
Dominant language
Jupyter Notebook
Stars
37
Forks
60
Avg merge
13h 32m
Merged PRs (30d)
5

Description

### User Story

As a developer, I want to determine if an editor configuration file (.editorconfig) is necessary for our web application and, if so, implement it to ensure consistent code formatting across different editors and IDEs.

### Description

An editor configuration file (.editorconfig) helps maintain consistent coding styles across different editors and IDEs. While we have configuration files for Prettier and ESLint, it is important to consider if an editor configuration file is necessary to further enforce consistent code formatting.

### Acceptance Criteria

- [ ] Evaluate the need for an editor configuration file (.editorconfig) based on the current codebase and development environment.
- [ ] If necessary, create an .editorconfig file at the root of the project directory.
- [ ] Define coding styles and formatting rules in the .editorconfig file to align with the existing Prettier and ESLint configurations.
- [ ] Ensure that the .editorconfig file is properly documented and adheres to best practices.
- [ ] Test the implementation to ensure that code formatting is consistent across different editors and IDEs.

### Technical References

[EditorConfig Documentation](https://editorconfig.org/)
[Visual Studio Code - EditorConfig Extension](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
[WebStorm - Configuration Code Style](https://www.jetbrains.com/help/webstorm/configuring-code-style.html)

### Design References

N/A

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.