Contributing

We welcome contributions to PikoClaw! Please follow these guidelines to ensure a smooth process.

Development Environment

1. Clone the repository:

   git clone https://github.com/nft2-me/PikoClaw.git
   cd PikoClaw
   

2. Backend Setup (Python):

   • It's recommended to use a virtual environment.

     python -m venv .venv
     source .venv/bin/activate
     pip install -r requirements.txt
     pip install -e .[dev] # Install in editable mode with dev dependencies
     

3. Frontend Setup (Next.js):

   cd web
   npm install
   

4. Run Locally:

   • Run the backend API server (details TBD).
   • Run the frontend dev server:

     cd web
     npm run dev
     

Pull Request Process

1. Fork the repository.
2. Create a new branch for your feature or bug fix (git checkout -b feat/my-new-feature).
3. Commit your changes with a clear, descriptive commit message.
4. Push your branch to your fork.
5. Open a pull request to the develop branch of the nft2-me/PikoClaw repository.
6. Ensure your PR description clearly explains the changes and why they are needed.
7. Link to any relevant issues.

Code Style

• Python: Follows black for code formatting.
• TypeScript/React: Follows prettier for code formatting.

Please run formatters before committing your code.