Skip to content

Add AGENTS guidelines #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Nitish-JS wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add AGENTS guidelines #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# AGENTS.md - CryptoHunter

## Development
- Requires Node.js ≥14.
- Install packages with `npm install --legacy-peer-deps`.
- Use `npm start` for the dev server.
- Before committing, verify the project builds by running `npm run build`.
- If any tests are present, run `npm test` as well.

## Style
- Use 2-space indentation and include semicolons.
- Favor React functional components as in existing files.
- Apply Prettier (or similar) to maintain consistent formatting.

## Commit messages
- Follow the structure `<scope>: <brief summary>`, e.g.
`Header: fix currency selector`.

## Pull requests
- Ensure `npm run build` succeeds and cite any test output in the PR body.