# Contributing to Dev-Sahad

Thank you for helping improve this GitHub profile and its automation.

## Useful contributions

- Fix broken links, spelling, accessibility, or Markdown rendering.
- Improve the profile's clarity without adding unverifiable claims.
- Make GitHub Actions safer, quieter, or more reliable.
- Improve the JavaScript generators and validation checks.
- Report stale or invalid generated assets.

Please avoid unrelated promotional links, fabricated statistics, generated spam, or changes to personal details without the maintainer's approval.

## Before opening a pull request

1. Fork and clone the repository.
2. Create a focused branch:

   ```bash
   git switch -c fix/short-description
   ```

3. Make the smallest change that solves the problem.
4. Run the local checks:

   ```bash
   npm run check
   git diff --check
   ```

5. Review `git diff --check` and ensure no secrets or unrelated files are included.
6. Open a pull request that explains the problem, the fix, and the validation performed.

## Commit messages

Use a short, descriptive message. Conventional prefixes are welcome:

- `fix:` for a bug fix
- `docs:` for documentation
- `ci:` for workflow changes
- `refactor:` for behavior-preserving cleanup
- `chore:` for maintenance

## Generated assets

The repository stores generated SVG files so the public profile does not depend entirely on live third-party responses. Do not edit generated files manually unless you are also fixing their generator or template.

- `terminal.svg` is generated by `scripts/make-terminal-svg.js`.
- `Assets/pixel-profile.json` and `Assets/pixel-profile.svg` are generated by `scripts/analyze-profile-image.js`.
- `Assets/trophy.svg` is generated by `scripts/generate-trophy.js`.
- `Assets/top-languages.svg` and `github-metrics.svg` are generated by scheduled workflows.

See the [maintenance guide](docs/MAINTENANCE.md) for regeneration procedures and the [automation guide](docs/AUTOMATION.md) for workflow behavior.

## Security reports

Do not disclose vulnerabilities in a public issue. Follow [SECURITY.md](SECURITY.md) and email [dev.sxhd@gmail.com](mailto:dev.sxhd@gmail.com).

## Code of conduct

Participation in this repository is governed by the [Code of Conduct](CODE_OF_CONDUCT.md).