Skip to content

Latest commit

 

History

History
66 lines (51 loc) · 3.04 KB

CONTRIBUTION.md

File metadata and controls

66 lines (51 loc) · 3.04 KB
# Contribution Guide

Thank you for considering contributing to TradingPal! We welcome contributions from the community to help improve our platform. Here are some ways you can contribute:

## How to Contribute

### Fixing Bugs and Issues
1. Check the [Issues](https://github.com/United-Visions/Trading_Pal-main/issues) section to find bugs or issues that need fixing.
2. Comment on the issue to let others know you are working on it.
3. Fork the repository and create a new branch for your fix.
4. Make your changes and commit them to your branch.
5. Push your changes to your forked repository.
6. Create a pull request to the main repository.

### Adding New Features
1. Check the [Issues](https://github.com/United-Visions/Trading_Pal-main/issues) section to see if the feature is already requested.
2. If not, create a new issue to discuss the feature with the community.
3. Fork the repository and create a new branch for your feature.
4. Implement the feature and commit your changes to your branch.
5. Push your changes to your forked repository.
6. Create a pull request to the main repository.

### Improving Documentation
1. Check the [Issues](https://github.com/United-Visions/Trading_Pal-main/issues) section for documentation improvement requests.
2. Fork the repository and create a new branch for your documentation changes.
3. Make your changes and commit them to your branch.
4. Push your changes to your forked repository.
5. Create a pull request to the main repository.

## Getting Started

To get started with contributing to TradingPal, follow these steps:

1. **Fork the Repository**: Click the "Fork" button at the top right of the repository page to create a copy of the repository in your GitHub account.
2. **Clone the Repository**: Clone your forked repository to your local machine using the following command:
   ```bash
   git clone https://github.com/your-username/Trading_Pal-main.git
  1. Create a Branch: Create a new branch for your feature or bug fix: 
    git checkout -b your-branch-name
  2. Make Changes: Make your changes to the codebase.
  3. Commit Changes: Commit your changes with a descriptive commit message: 
    git commit -m "Description of your changes"
  4. Push Changes: Push your changes to your forked repository: 
    git push origin your-branch-name
  5. Create a Pull Request: Go to the main repository and create a pull request from your forked repository.

Code of Conduct

Please note that this project is governed by a Code of Conduct. By participating, you are expected to uphold this code.

Support and Donations

We ask that everyone consider donating to support our efforts as we continue to develop and include advanced features. Your contributions will help us reach more users and revolutionize the way humanity invests in the markets. We are looking to collect live streaming data so we all can access the live charts, allowing even more functionality. Please help us achieve this goal.

Thank you for your contributions and support!