Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (58 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

79 lines (58 loc) · 2.13 KB

Contributing to Alphabots Public Repository

Thank you for your interest in contributing to Alphabots! This document provides guidelines for contributing to this repository.

How to Contribute

Reporting Bugs

If you find a bug, please create an issue with:

  • A clear title describing the bug
  • Steps to reproduce the issue
  • Expected vs actual behavior
  • Environment details (OS, Python version, etc.)
  • Screenshots or logs if applicable

Suggesting Enhancements

Have a feature idea? Create an issue with:

  • A clear description of the proposed feature
  • Why it would be useful
  • Potential implementation approach (if you have ideas)

Submitting Code Changes

  1. Fork the repository and clone it locally
  2. Create a branch for your feature: git checkout -b feature/your-feature-name
  3. Make your changes following the existing code style
  4. Test thoroughly before submitting
  5. Commit with clear, descriptive messages
  6. Push to your fork and create a Pull Request

Code Style Guidelines

Pine Script (TradingView)

  • Use version 5 syntax (//@version=5)
  • Include proper input parameters with clear labels
  • Add comments for complex logic
  • Format alerts as valid JSON

JSON/Webhook Messages

Follow this standard format:

```json { "order": [{ "type": "ENTRY", "symbol": "NSE:SYMBOL", "quantity": 1, "side": "B", "ordertype": "MARKET", "segment": "FUT", "product": "N" }] } ```

Python/Node.js Scripts

  • Follow PEP 8 (Python) or standard conventions (Node.js)
  • Add docstrings/comments for functions
  • Handle errors gracefully
  • Log important events

Documentation

  • Keep README.md files up to date
  • Add inline comments for complex code
  • Update SKILLS.md when adding new agent integration capabilities

Getting Help

License

By contributing, you agree that your contributions will be licensed under the MIT License.