Skip to content

Commit

Permalink
update readme file
Browse files Browse the repository at this point in the history
Signed-off-by: bryans-go <sabrinabryan1990@gmail.com>
  • Loading branch information
divanshu-go committed Oct 12, 2024
1 parent fe17202 commit 5d29dd2
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 7 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/format.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ jobs:
- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: '16' # Use the Node.js version your project requires
node-version: '16' # Use the Node.js version your project requires

- name: Install dependencies
run: npm install

- name: Run Prettier to check formatting
run: npm run prettier -- --check
continue-on-error: false # Fail the workflow if formatting issues are found
continue-on-error: false # Fail the workflow if formatting issues are found
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,23 @@ Once you've forked the repository, clone it to your local machine.
git clone https://github.com/YOUR-USERNAME/To-Do-List.git
```

## Linting and Formatting

This project uses **ESLint** and **Prettier** to ensure code quality and consistency.

- **ESLint** helps identify and fix problems in your JavaScript code.
- **Prettier** automatically formats your code to follow consistent styling rules.

### Running the Linter

To check your code for issues, run the following command:

```bash
npm run lint
```

This command will execute ESLint on your project files and report any errors or warnings.

## Maintainers

This project is actively maintained by:
Expand Down
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,23 @@ Open `index.html` in your browser to use the application.
- **Edit a Task:** Click the edit icon next to the task, make your changes, and save.
- **Delete a Task:** Click the delete icon next to the task.

## Linting and Formatting

This project uses **ESLint** and **Prettier** to ensure code quality and consistency.

- **ESLint** helps identify and fix problems in your JavaScript code.
- **Prettier** automatically formats your code to follow consistent styling rules.

### Running the Linter

To check your code for issues, run the following command:

```bash
npm run lint
```

This command will execute ESLint on your project files and report any errors or warnings.

## Contributing to Hacktoberfest 2024 🎉

![hecktoberfest](https://github.com/user-attachments/assets/9352e904-6b2d-495e-8140-1437e385ffdb)
Expand Down
10 changes: 5 additions & 5 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ import pluginJs from '@eslint/js';

export default [
{
files: ["**/*.js"],
languageOptions: {
globals: globals.browser
}
files: ['**/*.js'],
languageOptions: {
globals: globals.browser,
},
},
pluginJs.configs.recommended
pluginJs.configs.recommended,
];

0 comments on commit 5d29dd2

Please sign in to comment.