🤝 Contributing Guidelines

We welcome contributions from the community to improve this project! Please follow the steps below to ensure a smooth contribution process:

1. Fork & Clone

Fork the repository to your own GitHub account.

Clone your fork locally:

git clone https://github.com/<your-username>/<repo-name>.git
cd <repo-name>

Use a descriptive branch name for your feature or fix:

git checkout -b feature/add-order-validation

Follow the project’s coding style:

Solidity: Use the Solidity Style Guide.
JavaScript/TypeScript: Ensure code is formatted using Prettier and linted with ESLint.

Run before committing:

npm run lint
npm run format

Write clear, descriptive commit messages (preferably following Conventional Commits):

feat: add swap order validation

fix: correct contract address in deployment script

docs: improve setup instructions in README

Ensure all tests pass locally before submitting a PR:

npx hardhat test

Push your branch and open a PR against the main branch.

Clearly describe the problem and solution in your PR description.

Reference related issues (e.g., Closes #42).

All PRs will be reviewed by maintainers.

Address review comments promptly.

Once approved, the PR will be merged.

Use the Issues tab to report bugs or request features.

Please include reproduction steps, logs, or screenshots for bugs.