FinceptTerminal is a modern finance application offering advanced market analytics, investment research, and economic data tools, designed for interactive exploration and data-driven decision-making in a user-friendly environment.
C++ ai-agentsalgorithmic-tradingbloomberg-terminalcppfinancefinancial-marketsfintechgood-first-issueinvestmentinvestment-researchmachine-learningopensourcepythonqtquantitative-financestock-markettrading
contribution
12tilak340e9a8baf80cb
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.mdindex 963b9ee12..889ffcbb2 100644--- a/.github/CONTRIBUTING.md+++ b/.github/CONTRIBUTING.md@@ -1,99 +1,56 @@-# Contributing to Fincept Terminal+# 🎉 Contribute to Fincept Terminal 🚀-Thank you for considering contributing to Fincept Terminal! Your contributions help enhance the platform and provide better financial insights to users worldwide. Whether you're reporting a bug, suggesting an enhancement, or developing new features, your input is invaluable.+Hey there, awesome developer! 👋 Want to make Fincept Terminal even cooler? We’d love your help! Here’s how you can contribute:-## Table of Contents+## 🚀 Where We Need You-- [Code of Conduct](#code-of-conduct)-- [How Can I Contribute?](#how-can-i-contribute)- - [Reporting Bugs](#reporting-bugs)- - [Suggesting Enhancements](#suggesting-enhancements)- - [Submitting Pull Requests](#submitting-pull-requests)-- [Style Guides](#style-guides)- - [Coding Standards](#coding-standards)- - [Commit Messages](#commit-messages)-- [Additional Resources](#additional-resources)+💡 **Data Portals Integration**+ - Connect government financial databases (e.g., [data.gov.in](https://data.gov.in), [data.gov](https://www.data.gov/)).+ - Standardize global economic and financial data.-## Code of Conduct+📊 **Stock Backtesting & Analysis**+ - Build robust backtesting tools.+ - Implement new financial data visualization features.-By participating in this project, you agree to uphold our [Code of Conduct](CODE_OF_CONDUCT.md). We are committed to fostering an open and welcoming environment. Please report any unacceptable behavior to [[email protected]](mailto:[email protected]).+🌎 **New Data Sources**+ - Integrate global financial & alternative data providers.+ - Enhance data pipelines for market research.-## How Can I Contribute?+📈 **Brokerage API Integration**+ - Connect stock brokers so users can **buy/sell directly** from the terminal.+ - Work on **country-specific broker plugins**.-### Reporting Bugs+----If you encounter a bug, please report it by [creating an issue](https://github.com/Fincept-Corporation/FinceptTerminal/issues/new/choose). Provide detailed information to help us understand and resolve the issue promptly.+## 🛠 How to Get Started-**When reporting a bug, include:**+1️⃣ **Fork** this repo & clone it:+ ```bash+ git clone https://github.com/your-username/FinceptTerminal.git+ ```-- A clear and descriptive title.-- Steps to reproduce the issue.-- Expected and actual results.-- Screenshots or code snippets, if applicable.-- Any relevant logs or error messages.+2️⃣ **Create a new branch** for your feature:+ ```bash+ git checkout -b feature-awesome-feature+ ```-### Suggesting Enhancements+3️⃣ **Code like a rockstar 🎸**, follow [PEP8](https://www.python.org/dev/peps/pep-0008/), and document your changes.-We welcome suggestions to improve Fincept Terminal. To propose an enhancement, please [open a new issue](https://github.com/Fincept-Corporation/FinceptTerminal/issues/new/choose) and provide:+4️⃣ **Push your changes** and open a **pull request**:+ ```bash+ git push origin feature-awesome-feature+ ```-- A clear and descriptive title.-- A detailed description of the enhancement.-- The problem it addresses or the benefit it provides.-- Any relevant examples or references.+5️⃣ **Submit a PR** and boom 💥, you're contributing!-### Submitting Pull Requests+----We appreciate your contributions! Before submitting a pull request (PR), ensure it aligns with our project's goals and coding standards.+## 📝 Guidelines-**To submit a PR:**+✔ **Bug Reports:** [File an issue](https://github.com/Fincept-Corporation/FinceptTerminal/issues/new).+✔ **Feature Requests:** Let’s talk! Open a [GitHub Discussion](https://github.com/Fincept-Corporation/FinceptTerminal/discussions).+✔ **Code Contributions:** Keep it clean & simple. Well-documented code = ❤️.-1. **Fork the Repository:** Click the "Fork" button at the top right of the [repository page](https://github.com/Fincept-Corporation/FinceptTerminal).-2. **Clone Your Fork:** Use `git clone` to clone your fork to your local machine.-3. **Create a Branch:** Use `git checkout -b feature/your-feature-name` to create a new branch.-4. **Make Changes:** Implement your changes, ensuring adherence to our [Coding Standards](#coding-standards).-5. **Commit Changes:** Use descriptive commit messages as outlined in our [Commit Messages](#commit-messages) guide.-6. **Push to Fork:** Use `git push origin feature/your-feature-name` to push your changes.-7. **Open a PR:** Navigate to the original repository and [open a pull request](https://github.com/Fincept-Corporation/FinceptTerminal/compare).+🚀 **Join the movement!** Let’s build the future of finance together. Have questions? Ping us at [[email protected]](mailto:[email protected]).-**Ensure your PR:**--- Follows the project's coding standards.-- Includes relevant documentation updates.-- Passes all existing tests and includes new tests for your changes.-- Is linked to any related issues (e.g., "Closes #123").--## Style Guides--### Coding Standards--Consistency is key. Please adhere to the following standards:--- **Python Code:** Follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) guidelines.-- **Naming Conventions:** Use descriptive and meaningful names for variables, functions, and classes.-- **Comments:** Provide clear comments for complex logic and include docstrings for all public methods and classes.-- **Formatting:** Use consistent indentation (4 spaces) and limit lines to 79 characters.--### Commit Messages--Write clear and concise commit messages to convey the purpose of your changes.--**A good commit message includes:**--- **Title:** A brief summary of the changes (e.g., "Fix issue with data parsing in finance module").-- **Body (optional):** Detailed explanation of the changes, reasons, and any relevant information.--**Example:**-```-Add new data visualization feature--- Implement bar chart for financial data analysis-- Update requirements.txt to include matplotlib-- Add unit tests for the new visualization module-```--## Additional Resources--- **Documentation:** Refer to our [Wiki](https://github.com/Fincept-Corporation/FinceptTerminal/wiki) for detailed guides and information.-- **Contact:** For any queries or updates, reach out to us at [[email protected]](mailto:[email protected]).--We value your contributions and are excited to collaborate with you to improve Fincept Terminal!+👾 Happy coding! 🎉diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex 963b9ee12..889ffcbb2 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -1,99 +1,56 @@-# Contributing to Fincept Terminal+# 🎉 Contribute to Fincept Terminal 🚀-Thank you for considering contributing to Fincept Terminal! Your contributions help enhance the platform and provide better financial insights to users worldwide. Whether you're reporting a bug, suggesting an enhancement, or developing new features, your input is invaluable.+Hey there, awesome developer! 👋 Want to make Fincept Terminal even cooler? We’d love your help! Here’s how you can contribute:-## Table of Contents+## 🚀 Where We Need You-- [Code of Conduct](#code-of-conduct)-- [How Can I Contribute?](#how-can-i-contribute)- - [Reporting Bugs](#reporting-bugs)- - [Suggesting Enhancements](#suggesting-enhancements)- - [Submitting Pull Requests](#submitting-pull-requests)-- [Style Guides](#style-guides)- - [Coding Standards](#coding-standards)- - [Commit Messages](#commit-messages)-- [Additional Resources](#additional-resources)+💡 **Data Portals Integration**+ - Connect government financial databases (e.g., [data.gov.in](https://data.gov.in), [data.gov](https://www.data.gov/)).+ - Standardize global economic and financial data.-## Code of Conduct+📊 **Stock Backtesting & Analysis**+ - Build robust backtesting tools.+ - Implement new financial data visualization features.-By participating in this project, you agree to uphold our [Code of Conduct](CODE_OF_CONDUCT.md). We are committed to fostering an open and welcoming environment. Please report any unacceptable behavior to [[email protected]](mailto:[email protected]).+🌎 **New Data Sources**+ - Integrate global financial & alternative data providers.+ - Enhance data pipelines for market research.-## How Can I Contribute?+📈 **Brokerage API Integration**+ - Connect stock brokers so users can **buy/sell directly** from the terminal.+ - Work on **country-specific broker plugins**.-### Reporting Bugs+----If you encounter a bug, please report it by [creating an issue](https://github.com/Fincept-Corporation/FinceptTerminal/issues/new/choose). Provide detailed information to help us understand and resolve the issue promptly.+## 🛠 How to Get Started-**When reporting a bug, include:**+1️⃣ **Fork** this repo & clone it:+ ```bash+ git clone https://github.com/your-username/FinceptTerminal.git+ ```-- A clear and descriptive title.-- Steps to reproduce the issue.-- Expected and actual results.-- Screenshots or code snippets, if applicable.-- Any relevant logs or error messages.+2️⃣ **Create a new branch** for your feature:+ ```bash+ git checkout -b feature-awesome-feature+ ```-### Suggesting Enhancements+3️⃣ **Code like a rockstar 🎸**, follow [PEP8](https://www.python.org/dev/peps/pep-0008/), and document your changes.-We welcome suggestions to improve Fincept Terminal. To propose an enhancement, please [open a new issue](https://github.com/Fincept-Corporation/FinceptTerminal/issues/new/choose) and provide:+4️⃣ **Push your changes** and open a **pull request**:+ ```bash+ git push origin feature-awesome-feature+ ```-- A clear and descriptive title.-- A detailed description of the enhancement.-- The problem it addresses or the benefit it provides.-- Any relevant examples or references.+5️⃣ **Submit a PR** and boom 💥, you're contributing!-### Submitting Pull Requests+----We appreciate your contributions! Before submitting a pull request (PR), ensure it aligns with our project's goals and coding standards.+## 📝 Guidelines-**To submit a PR:**+✔ **Bug Reports:** [File an issue](https://github.com/Fincept-Corporation/FinceptTerminal/issues/new).+✔ **Feature Requests:** Let’s talk! Open a [GitHub Discussion](https://github.com/Fincept-Corporation/FinceptTerminal/discussions).+✔ **Code Contributions:** Keep it clean & simple. Well-documented code = ❤️.-1. **Fork the Repository:** Click the "Fork" button at the top right of the [repository page](https://github.com/Fincept-Corporation/FinceptTerminal).-2. **Clone Your Fork:** Use `git clone` to clone your fork to your local machine.-3. **Create a Branch:** Use `git checkout -b feature/your-feature-name` to create a new branch.-4. **Make Changes:** Implement your changes, ensuring adherence to our [Coding Standards](#coding-standards).-5. **Commit Changes:** Use descriptive commit messages as outlined in our [Commit Messages](#commit-messages) guide.-6. **Push to Fork:** Use `git push origin feature/your-feature-name` to push your changes.-7. **Open a PR:** Navigate to the original repository and [open a pull request](https://github.com/Fincept-Corporation/FinceptTerminal/compare).+🚀 **Join the movement!** Let’s build the future of finance together. Have questions? Ping us at [[email protected]](mailto:[email protected]).-**Ensure your PR:**--- Follows the project's coding standards.-- Includes relevant documentation updates.-- Passes all existing tests and includes new tests for your changes.-- Is linked to any related issues (e.g., "Closes #123").--## Style Guides--### Coding Standards--Consistency is key. Please adhere to the following standards:--- **Python Code:** Follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) guidelines.-- **Naming Conventions:** Use descriptive and meaningful names for variables, functions, and classes.-- **Comments:** Provide clear comments for complex logic and include docstrings for all public methods and classes.-- **Formatting:** Use consistent indentation (4 spaces) and limit lines to 79 characters.--### Commit Messages--Write clear and concise commit messages to convey the purpose of your changes.--**A good commit message includes:**--- **Title:** A brief summary of the changes (e.g., "Fix issue with data parsing in finance module").-- **Body (optional):** Detailed explanation of the changes, reasons, and any relevant information.--**Example:**-```-Add new data visualization feature--- Implement bar chart for financial data analysis-- Update requirements.txt to include matplotlib-- Add unit tests for the new visualization module-```--## Additional Resources--- **Documentation:** Refer to our [Wiki](https://github.com/Fincept-Corporation/FinceptTerminal/wiki) for detailed guides and information.-- **Contact:** For any queries or updates, reach out to us at [[email protected]](mailto:[email protected]).--We value your contributions and are excited to collaborate with you to improve Fincept Terminal!+👾 Happy coding! 🎉