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
12tilak345422e5e8674a
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.mdnew file mode 100644index 000000000..963b9ee12--- /dev/null+++ b/.github/CONTRIBUTING.md@@ -0,0 +1,99 @@+# Contributing 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.++## Table of Contents++- [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)++## Code of Conduct++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]).++## How Can I Contribute?++### 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.++**When reporting a bug, include:**++- 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.++### Suggesting Enhancements++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:++- 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.++### Submitting Pull Requests++We appreciate your contributions! Before submitting a pull request (PR), ensure it aligns with our project's goals and coding standards.++**To submit a PR:**++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).++**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!diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdnew file mode 100644index 000000000..963b9ee12--- /dev/null+++ b/CONTRIBUTING.md@@ -0,0 +1,99 @@+# Contributing 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.++## Table of Contents++- [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)++## Code of Conduct++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]).++## How Can I Contribute?++### 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.++**When reporting a bug, include:**++- 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.++### Suggesting Enhancements++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:++- 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.++### Submitting Pull Requests++We appreciate your contributions! Before submitting a pull request (PR), ensure it aligns with our project's goals and coding standards.++**To submit a PR:**++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).++**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!diff --git a/README.md b/README.mdindex 28a87c6d3..b123db55b 100644--- a/README.md+++ b/README.md@@ -67,14 +67,17 @@ fincept --version- **Country Specific Data**- **Making AI Based Terminal**-### Become a Contributor+### Become a Contributor (Developer) 🚀-We welcome contributions from everyone! Check out our [Contributing Documentation](https://docs.fincept.in/contributing) for detailed guidelines on how you can start contributing to the Fincept Terminal.+We welcome contributions from everyone! Whether you're fixing bugs, adding new features, or improving documentation, **your help is valuable!**++📌 **Read the Contribution Guidelines:**+Check out our [CONTRIBUTING.md](https://github.com/Fincept-Corporation/FinceptTerminal/blob/main/CONTRIBUTING.md) to learn how you can contribute to Fincept Terminal.## Table of Contents- [Code of Conduct](#code-of-conduct)-- [How Can I Contribute?](#how-can-i-contribute)+- [How Can I as a User Contribute?](#how-can-i-contribute)- [Reporting Bugs](#reporting-bugs)- [Suggesting Enhancements](#suggesting-enhancements)- [Submitting Pull Requests](#submitting-pull-requests)@@ -99,9 +102,11 @@ If you encounter any issues or have suggestions, feel free to create a GitHub ti[](https://star-history.com/#Fincept-Corporation/fincept-investments&Date)+📌 **Join the Community:**+- Discuss ideas and improvements in [GitHub Discussions](https://github.com/Fincept-Corporation/FinceptTerminal/discussions)+- Report bugs in [GitHub Issues](https://github.com/Fincept-Corporation/FinceptTerminal/issues)+- Connect with us via email at [[email protected]](mailto:[email protected])-## FOR ANY QUERY OR UPDATE REACH OUT TO US ON [email protected]-## Contact Us 📞Have questions or feedback? Facing issues? Fill out our contact form:[Google Form: Contact Us](https://forms.gle/DUsDHwxBNRVstYMi6)