Skip to content

Commit

Permalink
docs(readme,-contrib): nano changes
Browse files Browse the repository at this point in the history
  • Loading branch information
vladzima committed Oct 27, 2024
1 parent 6f56ea5 commit e3af2b7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
13 changes: 5 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,25 @@ First of all, thank you for taking the time to contribute! 🎉
## Development Workflow

1. Make your changes in the new branch.
2. **Test** your changes before submitting a PR:
```bash
npm run test
```
3. Run **linting** to ensure code style:

2. Run **linting** to ensure code style:
```bash
npm run lint
```

4. Once you're done, **commit** your changes using Commitizen:
3. Once you're done, **commit** your changes using Commitizen:
```bash
git add .
npm run commit
```
- We use [Commitizen](https://github.com/commitizen/cz-cli) to ensure consistent commit messages. Follow the prompts to create a meaningful commit message.
5. **Push** your branch to GitHub:
4. **Push** your branch to GitHub:
```bash
git push origin feature/your-feature-name
```
6. **Create a Pull Request** (PR) on GitHub:
5. **Create a Pull Request** (PR) on GitHub:
- Include a detailed description of your changes.
- Reference related issues if applicable.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

**Detecto is a React library designed to help developers automatically detect when a user's browser is experiencing performance issues such as throttling or lag**. When performance issues are detected, the application can adapt to provide a smoother, more lightweight experience for the user.

Modern websites often feature rich animations, high-resolution images, and interactive elements that can be resource-intensive, especially on older or low-powered devices. By using Detecto, you can detect when the user's browsing environment is struggling and adjust your UI dynamically to keep the user experience optimal, even under less-than-ideal conditions.
Modern websites often feature rich animations, high-resolution images, and interactive elements that can be resource-intensive, especially on older or low-powered devices. By using Detecto, you can *detect* when the user's browsing environment is struggling and adjust your UI dynamically to keep the user experience optimal, even under less-than-ideal conditions.

## Key Features

Expand Down

0 comments on commit e3af2b7

Please sign in to comment.