Contributing

​

Welcome Contributors

​

Ways to Contribute

​

Getting Started

​

Repository Structure

​

Development Setup

1. Fork the repository
   # Clone your fork
   git clone https://github.com/YOUR_USERNAME/syra.git
   cd syra
   
2. Install dependencies
   # Install dependencies for the package you want to work on
   cd <package-name>
   npm install
   
3. Create a branch
   git checkout -b feature/your-feature-name
   
4. Make your changes
   • Write clean, well-documented code
   • Follow existing code style and conventions
   • Add tests for new functionality
5. Test your changes
   # Run tests for the package
   npm test
   
6. Commit and push
   git add .
   git commit -m "Description of your changes"
   git push origin feature/your-feature-name
   
7. Create a Pull Request
   • Go to the original repository on GitHub
   • Click “New Pull Request”
   • Describe your changes in detail

​

Contribution Guidelines

​

Code Quality

• Follow existing patterns: Maintain consistency with the current codebase
• Write clear comments: Explain complex logic and decision-making
• Keep it focused: One feature or fix per pull request
• Test thoroughly: Ensure your changes don’t break existing functionality

​

Commit Messages

# Good examples
git commit -m "Add support for new technical indicators"
git commit -m "Fix RSI calculation edge case"
git commit -m "Update API documentation for signal endpoint"

# Avoid
git commit -m "fix stuff"
git commit -m "updates"

​

Pull Request Guidelines

1. Provide context: Explain what problem you’re solving and why
2. Reference issues: Link to related GitHub issues if applicable
3. Include screenshots: For UI changes, show before/after
4. Update documentation: Add or update docs for new features
5. Be responsive: Address feedback and questions promptly

​

Documentation Contributions

​

Running the Docs Locally

cd documentation
npm install
npm start

​

Documentation Standards

• Clear and concise: Use simple language and short sentences
• Include examples: Show practical usage with code snippets
• Keep it current: Update docs when features change
• Check for typos: Proofread before submitting

​

Reporting Bugs

​

What to Include

• Clear description: What happened vs. what you expected
• Reproduction steps: Exact steps to reproduce the issue
• Environment: Platform, browser, version numbers
• Screenshots/logs: Visual evidence or error messages
• Impact: How does this affect your use of Syra?

​

Where to Report

• Telegram bot: Use /feedback command for quick reports
• GitHub Issues: For detailed technical issues
• X (Twitter): For general feedback and discussions

​

Feature Requests

​

Before Requesting

1. Search existing requests: Check if someone already suggested it
2. Consider the scope: Does it fit Syra’s mission and goals?
3. Think about implementation: How might it work technically?

​

What to Include

• Use case: Why is this feature needed?
• Expected behavior: How should it work?
• Examples: Similar features in other tools
• Priority: How important is this to you?

​

Code of Conduct

​

Our Standards

• Be respectful: Treat everyone with kindness and professionalism
• Be constructive: Provide helpful feedback and suggestions
• Be collaborative: Work together toward common goals
• Be patient: Remember that everyone is learning

​

Unacceptable Behavior

• Harassment, discrimination, or offensive comments
• Trolling, insulting, or derogatory remarks
• Publishing others’ private information
• Any conduct that creates a hostile environment

​

Recognition

• Contributors are listed in project documentation
• Significant contributions are highlighted in release notes
• Active contributors may be invited to become maintainers

​

Questions?

• Ask in the Telegram bot using /feedback
• Reach out on X (Twitter)
• Check the documentation

​

Thank You!