xrpl-evm-auditor/CONTRIBUTING.md

A Solidity static analysis tool for XRPL EVM sidechain. Detects common smart contract vulnerabilities.

# Contributing to XRPL EVM Auditor

👋 **Thank you for considering contributing to XRPL EVM Auditor!**  
We welcome contributions to improve and extend this Solidity smart contract security analyzer for the XRPL EVM Sidechain.

---

## 📜 Code of Conduct

Please be respectful and considerate in all discussions. See [CODE OF CONDUCT](https://opensource.guide/code-of-conduct/) (if added later).

---

## ✅ How to Contribute

### 1. Fork the Repository

Click **Fork** at the top right of the [main repo](https://github.com/hiddenciphers/xrpl-evm-auditor).

### 2. Clone Your Fork

```
git clone https://github.com/YOUR-USERNAME/xrpl-evm-auditor.git
cd xrpl-evm-auditor
```

### 3. Create a Feature/Issue Branch

```
git checkout -b feature/your-feature-nam
```

### 4. Install Dependencies

```
npm install
```

---

### 🧪 Running Tests

Please run tests and ensure they pass before submitting a PR.

```
npm test
```

✅ All PRs are required to pass tests (enforced via GitHub Actions).

---

### 💻 Development Workflow

#### Making a Contribution:

1. Create a branch for your feature or fix.

2. Commit your changes with clear commit messages.

3. Push your branch to your fork:

```
git push origin feature/your-feature-name
```

4. Open a Pull Request (PR) against main on the upstream repo.

---

### 🔐 Branch Protection Rules

- Direct pushes to main are blocked — all changes must go via Pull Requests.

- Passing tests are required before a PR can be merged.

- At least one review may be required before merge (if maintainers are set).

---

### ✅ Example Commit Message

```
feat: add detection for dangerous fallback functions

Fixes #12
```

---

### 🤝 Need Help?

Open an [Issue](https://github.com/hiddenciphers/xrpl-evm-auditor/issues) if you need help, or want to suggest features/bugs.

---

### 🙌 Thank You for Contributing!

Together, we can build a safer XRPL EVM ecosystem! 🚀