Welcome to the FinGPT project! We are thrilled to have you here 🌟. Your contributions are instrumental in shaping the intersection of finance and AI, making it even more amazing. 📈✨ Let's embark on this journey together.
Before diving in, please take a moment to review our Code of Conduct. It sets the tone for our community and emphasizes the importance of respect and inclusivity. Read the Code of Conduct.
If you encounter any bugs during your journey, don't fret! We have the Bug Busters ready to help. To report a bug, follow these steps:
- Check if the bug has already been reported in GitHub Issues.
- If it's a new bug, open a new issue with a concise description and provide detailed, step-by-step instructions to reproduce it.
Do you have visionary ideas that could elevate FinGPT? Share them with us! When submitting a feature request, be sure to include:
- A clear and vivid description of the feature you envision.
- Discuss the impact and potential benefits.
For those with a penchant for words and an eye for detail, consider contributing to our documentation. You can make the documentation more enlightening for everyone. 🧙📜
Calling all AI heroes and wizards! You are the secret sauce behind the FinGPT project. To contribute code and save the financial world:
-
Fork the Repository: Click the "Fork" button on the top right of the repository's page. This creates your own copy of the project.
-
Clone your Fork: In your terminal, use the following command to clone your fork to your local machine:
git clone https://github.com/YourUsername/FinGPT.git
-
Create a New Branch: Make a new branch for your adventures. This helps keep the main codebase clean:
git checkout -b your-feature-branch
-
Work Your Magic: Implement your code or changes.
-
Commit and Push: Use these commands to commit your changes and push them to your fork:
git commit -m "Your commit message" git push origin your-feature-branch -
Create a Pull Request: Go to the original FinGPT repository and click "New Pull Request." Select your branch, write a description, and submit.
If you find yourself stuck or have questions, remember that our support team is your sidekick. Don't hesitate to reach out. We are here to guide you through the process and provide any necessary assistance.
Are you ready to make a mark on the FinGPT project? Grab your cape and join us in our mission to make finance and AI even more incredible. Your contributions are the magic that fuels our journey.