beatrizsmerino / beatrizsmerino/angular-setup
feat(package): add `description` to `package.json` and `README.md`
- Dominant language
- No language data
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
# feat(package): add `description` to `package.json` and `README.md`
| β±οΈ Estimate | π Priority | π Size | π
Start | π
End |
| --- | --- | --- | --- | --- |
| 1h | P2 | XS | 02-03-2026 | 02-03-2026 |
## πΈ Screenshots
| Current | Expected |
| :---: | :---: |
| N/A β This change has no visual impact. | N/A β This change has no visual impact. |
## π Summary
- Add `description` field to `package.json` to document the project purpose
- Add `## Description` section to `README.md`
## π‘ Why this change?
- The `description` field is missing from `package.json`
- The `README.md` does not have a description section
- Tools like npm, bundlers and documentation generators use this field to describe the package
## β Benefits
- The project description is available in `package.json` for npm registry and tooling
- The `README.md` documents the project purpose for developers
- Consistent with the GitHub repository description
## π Steps
### Phase 1: Add description field to `package.json`
- [x] Add `description` field to `package.json`:
```diff
{
"name": "angular-setup",
"version": "0.0.0",
+ "description": "Base Angular setup project with ESLint, Prettier and TypeScript configuration",
"author": {
"name": "Beatriz SopeΓ±a Merino",
...
},
...
}
```
### Phase 2: Add description section to `README.md`
- [x] Add `## Description` section to `README.md`:
```diff
# AngularSetup
This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 21.2.0.
+## Description
+
+Base Angular setup project with Prettier, ESLint and TypeScript configuration
+
## Development server
```
## π§ͺ Tests
- [x] Verify `package.json` is valid:
```bash
npm install
```
## π References
### Files to modify
- `package.json`
- `README.md`
### Documentation
- https://docs.npmjs.com/cli/v10/configuring-npm/package-json#description
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.