Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
24 lines (19 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

24 lines (19 loc) · 1.26 KB
Raw

Contributing to Arbitrage Inception

Thank you for your interest in contributing to Arbitrage Inception! We welcome open-source contributions from developers, researchers, and DeFi builders across BNB Smart Chain and EVM ecosystems.

Code of Conduct

All contributors are expected to uphold our Code of Conduct.

Getting Started

  1. Fork the repository to your personal GitHub account.
  2. Clone your fork locally.
  3. Create a feature branch: git checkout -b feat/your-feature-name.
  4. Implement your changes adhering to existing linting and formatting standards.
  5. Ensure all tests pass: npm test or pytest.

Contribution Standards

  • Non-Custodial Architecture: All smart contract interactions and swap routing must remain strictly non-custodial.
  • Zero Secrets in Git: Never commit private keys, API secrets, or sensitive configuration files.
  • Clear Commit Messages: Use Conventional Commits (feat:, fix:, docs:, refactor:, test:).
  • Affiliation Disclosure: If submitting external resources or protocol integrations, disclose any team affiliation transparently.

Submitting Pull Requests

  • Fill out the PR template completely.
  • Reference any related open issue numbers.
  • Ensure all CI/CD automated checks pass.