Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

84 lines (59 loc) · 2.71 KB

Contributing to TradingView to Bitunix Trading Bot

First off, thank you for considering contributing to this project! It's people like you that make this bot better for everyone.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct:

  • Use welcoming and inclusive language
  • Be respectful of differing viewpoints and experiences
  • Gracefully accept constructive criticism
  • Focus on what is best for the community
  • Show empathy towards other community members

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the existing issues to avoid duplicates. When you create a bug report, include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include any error messages or logs

Suggesting Enhancements

If you have a suggestion for the project:

  • Use a clear and descriptive title
  • Provide a detailed description of the suggested enhancement
  • Explain why this enhancement would be useful
  • List some examples of how it would be used

Pull Requests

  1. Fork the repo and create your branch from main
  2. If you've added code that should be tested, add tests
  3. Ensure the test suite passes
  4. Make sure your code follows the existing code style
  5. Write a convincing description of your PR and why we should land it

Development Process

  1. Clone the repository
  2. Create a new branch: git checkout -b feature/my-feature or bugfix/issue-number
  3. Make your changes
  4. Run tests: npm run test:all
  5. Commit your changes using a descriptive commit message
  6. Push to your fork and submit a pull request

Style Guidelines

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

JavaScript/TypeScript Style Guide

  • Use TypeScript for all new code
  • Follow the existing code style
  • Use meaningful variable names
  • Add comments for complex logic
  • Keep functions focused and small
  • Write unit tests for new functionality

Additional Notes

Issue and Pull Request Labels

  • bug: Something isn't working
  • enhancement: New feature or request
  • documentation: Improvements or additions to documentation
  • help-wanted: Extra attention is needed
  • good-first-issue: Good for newcomers

Questions?

Feel free to open an issue with your question or contact the maintainers directly.