Added telemetry doc

README.md

@@ -264,6 +264,9 @@ Since this is a research project, there are many areas that need to be researche
 ## 🖥 Development
 Other than the research, GPT Pilot needs to be debugged to work in different scenarios. For example, we realized that the quality of the code generated is very sensitive to the size of the development task. When the task is too broad, the code has too many bugs that are hard to fix, but when the development task is too narrow, GPT also seems to struggle in getting the task implemented into the existing code.
 
+## 📊 Telemetry
+To improve GPT Pilot, we are tracking some events from which you can opt out at any time. You can read more about it here.
+
 # 🔗 Connect with us
 🌟 As an open-source tool, it would mean the world to us if you starred the GPT-pilot repo 🌟
 

docs/TELEMETRY.md

@@ -0,0 +1,41 @@
+## Telemetry in GPT Pilot
+
+At GPT Pilot, we are dedicated to improving your experience and the overall quality of our software. To achieve this, we gather anonymous telemetry data which helps us understand how the tool is being used and identify areas for improvement.
+
+### What We Collect
+
+The telemetry data we collect includes:
+
+- **Total Runtime**: The total time GPT Pilot was active and running.
+- **Command Runs**: How many commands were executed during a session.
+- **Development Steps**: The number of development steps that were performed.
+- **LLM Requests**: The number of LLM requests made.
+- **User Inputs**: The number of times you provide input to the tool.
+
+### How We Use This Data
+
+We use this data to:
+
+- Monitor the performance and reliability of GPT Pilot.
+- Understand usage patterns to guide our development and feature prioritization.
+- Identify common workflows and improve the user experience.
+- Ensure the scalability and efficiency of our language model interactions.
+
+### Your Privacy
+
+Your privacy is important to us. The data collected is purely for internal analysis and will not be shared with third parties. No personal information is collected, and telemetry data is completely anonymized. We adhere to best practices in data security to protect this information.
+
+### Opting Out
+
+We believe in transparency and control. If you prefer not to send telemetry data, you can opt-out at any time by running the following command:
+
+```bash
+gpt-pilot telemetry disable
+```
+
+After you run this command, GPT Pilot will no longer collect telemetry data from your machine.
+
+### Questions and Feedback
+If you have questions about our telemetry practices or would like to provide feedback, please open an issue in our repository, and we will be happy to engage with you.
+
+Thank you for supporting GPT Pilot and helping us make it better for everyone.