From 4d89794915f69a80c573e7d37aafc9120ac8a1a0 Mon Sep 17 00:00:00 2001 From: reibs Date: Mon, 23 Sep 2024 17:55:24 -0700 Subject: [PATCH 1/4] added yaml --- .github/ISSUE_TEMPLATE/bug.yaml | 58 +++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yaml diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml new file mode 100644 index 000000000..e02d60186 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -0,0 +1,58 @@ +name: ๐Ÿ› Bug Report +description: Noticed something off with Agentops? Let us know! +title: "[Bug]: " +labels: ["bug"] +assignees: [] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! Your feedback helps us improve Agentops. + - type: textarea + id: bug-description + attributes: + label: ๐Ÿ”Ž Describe the Bug + description: Give a clear and concise description of the bug. + placeholder: What went wrong? + validations: + required: true + - type: textarea + id: reproduction-steps + attributes: + label: ๐Ÿ”„ Reproduction Steps + description: List the steps to reproduce the behavior. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: false + - type: textarea + id: expected-behavior + attributes: + label: ๐Ÿ™ Expected Behavior + description: Describe what you expected to happen. + placeholder: What should have happened? + validations: + required: false + - type: textarea + id: screenshots + attributes: + label: ๐Ÿ“ธ Screenshots + description: If applicable, add screenshots to help explain the problem. + placeholder: Drag and drop images here, or paste image links. + validations: + required: false + - type: textarea + id: additional-context + attributes: + label: ๐Ÿ” Additional Context + description: Provide any other context about the problem here. + placeholder: Any other relevant information? + validations: + required: false + - type: markdown + attributes: + value: | + Thank you for helping us improve Agentops! \ No newline at end of file From f4cdf0244736d9e1961467386a0e22aa058633d3 Mon Sep 17 00:00:00 2001 From: reibs Date: Mon, 23 Sep 2024 18:21:25 -0700 Subject: [PATCH 2/4] Update issue templates --- .github/ISSUE_TEMPLATE/bug.yaml | 58 ------------------- .github/ISSUE_TEMPLATE/bug_report.md | 26 --------- .github/ISSUE_TEMPLATE/bug_report.yaml | 53 +++++++++++++++++ .../ISSUE_TEMPLATE/documentation_update.md | 21 ------- .../ISSUE_TEMPLATE/documentation_update.yaml | 53 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 27 --------- .github/ISSUE_TEMPLATE/feature_request.yaml | 37 ++++++++++++ 7 files changed, 143 insertions(+), 132 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug.yaml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/documentation_update.md create mode 100644 .github/ISSUE_TEMPLATE/documentation_update.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml deleted file mode 100644 index e02d60186..000000000 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ /dev/null @@ -1,58 +0,0 @@ -name: ๐Ÿ› Bug Report -description: Noticed something off with Agentops? Let us know! -title: "[Bug]: " -labels: ["bug"] -assignees: [] -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this bug report! Your feedback helps us improve Agentops. - - type: textarea - id: bug-description - attributes: - label: ๐Ÿ”Ž Describe the Bug - description: Give a clear and concise description of the bug. - placeholder: What went wrong? - validations: - required: true - - type: textarea - id: reproduction-steps - attributes: - label: ๐Ÿ”„ Reproduction Steps - description: List the steps to reproduce the behavior. - placeholder: | - 1. Go to '...' - 2. Click on '....' - 3. Scroll down to '....' - 4. See error - validations: - required: false - - type: textarea - id: expected-behavior - attributes: - label: ๐Ÿ™ Expected Behavior - description: Describe what you expected to happen. - placeholder: What should have happened? - validations: - required: false - - type: textarea - id: screenshots - attributes: - label: ๐Ÿ“ธ Screenshots - description: If applicable, add screenshots to help explain the problem. - placeholder: Drag and drop images here, or paste image links. - validations: - required: false - - type: textarea - id: additional-context - attributes: - label: ๐Ÿ” Additional Context - description: Provide any other context about the problem here. - placeholder: Any other relevant information? - validations: - required: false - - type: markdown - attributes: - value: | - Thank you for helping us improve Agentops! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 5f0338a3a..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: ๐Ÿ› Bug Report -about: Noticed something off with Agentops? Let us know! -title: '' -labels: 'bug' -assignees: '' ---- - -## ๐Ÿ› Bug Report - -**๐Ÿ”Ž Describe the Bug** -Give a clear and concise description of the bug. - -**๐Ÿ”„ Reproduction Steps** -List the steps to reproduce the behavior. - -**๐Ÿ™ Expected Behavior** -Describe what you expected to happen. - -**๐Ÿ“ธ Screenshots** -If applicable, add screenshots to help explain the problem. - -**๐Ÿ” Additional Context** -Provide any other context about the problem here. - -Thank you for helping us improve Agentops! diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 000000000..f8bb79a75 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,53 @@ +name: ๐Ÿ› Bug Report +description: Noticed something off with Agentops? Let us know! +title: "[Bug]: " +labels: ["bug"] +assignees: [] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! Your feedback helps us improve AgentOps. + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: input + id: package-version + attributes: + label: ๐Ÿ“ฆ Package Version + description: What version of Agentops are you using? + placeholder: ex. 0.3.12 + validations: + required: true + - type: input + id: framework-version + attributes: + label: ๐ŸŽž๏ธ Framework Version + description: Which frameworks are you using? (if applicable) + placeholder: ex. Autogen 0.3.0, CrewAI 0.61.0, Langchain 0.2.1 + validations: + required: false + - type: textarea + id: bug-description + attributes: + label: ๐Ÿ”Ž Describe the Bug + description: Give a clear and concise description of the bug and how to reproduce it. Include any error messages and screenshots. + placeholder: What went wrong? + validations: + required: true + - type: checkboxes + id: contribution + attributes: + label: ๐Ÿค Contribution + description: Would you be willing to contribute to this update? + options: + - label: Yes, I'd be happy to submit a pull request with these changes. + - label: I need some guidance on how to contribute. + - label: I'd prefer the AgentOps team to handle this update. + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation_update.md b/.github/ISSUE_TEMPLATE/documentation_update.md deleted file mode 100644 index 5a4bdb2d1..000000000 --- a/.github/ISSUE_TEMPLATE/documentation_update.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: ๐Ÿ“š Documentation Update -about: Suggest an improvement or addition to our documentation -title: '' -labels: 'documentation' -assignees: '' - ---- - -## ๐Ÿ“š Documentation Update - -**๐Ÿ“˜ Describe the current state of documentation** -What information is missing or could be improved? - -**๐Ÿ“– Suggested Improvement** -Describe your idea for the new/improved documentation. - -**๐Ÿ” Additional Context** -Any extra information to help us understand the change? - -Thank you for helping us improve Agentops documentation! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation_update.yaml b/.github/ISSUE_TEMPLATE/documentation_update.yaml new file mode 100644 index 000000000..016c98899 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_update.yaml @@ -0,0 +1,53 @@ +name: ๐Ÿ“š Documentation Update +description: Suggest an improvement or addition to our documentation +title: "[Docs]: " +labels: ["documentation"] +assignees: [] +body: + - type: markdown + attributes: + value: | + Thank you for helping us improve AgentOps documentation! Your input is valuable in making our docs more helpful and comprehensive. + - type: textarea + id: current-state + attributes: + label: ๐Ÿ“˜ Current State of Documentation + description: What information is missing or could be improved? + placeholder: Describe the current state of the documentation you'd like to update. + validations: + required: true + - type: textarea + id: suggested-improvement + attributes: + label: ๐Ÿ“– Suggested Improvement + description: Describe your idea for the new/improved documentation. + placeholder: What changes or additions would you like to see? + validations: + required: true + - type: input + id: affected-pages + attributes: + label: ๐Ÿ”— Affected Documentation Pages + description: If applicable, provide links to the documentation pages that need updating. + placeholder: https://docs.agentops.ai/page-to-update + validations: + required: false + - type: textarea + id: additional-context + attributes: + label: ๐Ÿ” Additional Context + description: Any extra information to help us understand the change? + placeholder: Provide any additional details or context for the documentation update. + validations: + required: false + - type: checkboxes + id: contribution + attributes: + label: ๐Ÿค Contribution + description: Would you be willing to contribute to this documentation update? + options: + - label: Yes, I'd be happy to submit a pull request with these changes. + - label: I need some guidance on how to contribute. + - label: I'd prefer the Agentops team to handle this update. + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index a7e0a3cd4..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: ๐Ÿš€ Feature Request -about: Got an idea to improve Agentops? We're all ears! -title: '' -labels: 'enhancement' -assignees: '' ---- - -## ๐Ÿš€ Feature Request - -**๐Ÿ’ก Got a brilliant idea?** -Briefly describe your feature suggestion. We're all about improving agent observability and performance. - -**๐Ÿค” Is your feature request related to a problem?** -If your feature request is related to a problem you're facing, describe it here. The more we understand your struggle, the better we can address it. - -**๐ŸŽ‰ Describe the solution you'd like** -What's your solution? Be as detailed as possible. - -**๐Ÿ“š Have you considered any alternatives?** -Share any alternative solutions or features you've considered. - -**๐Ÿ–ผ๏ธ Can you provide a visual mock-up or sketch?** -If possible, provide a visual mock-up or sketch of your feature request. Visual aids can help us better understand your vision. - -**๐Ÿ” Additional context** -Any extra information or context to help us understand better? Share it here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 000000000..ddffaeb84 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,37 @@ +name: ๐Ÿš€ Feature Request +description: Got an idea to improve AgentOps? We're all ears! +title: "[Feature]: " +labels: ["enhancement"] +assignees: [] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to share your feature idea! Your input helps us improve AgentOps. + - type: textarea + id: feature-description-and-solution + attributes: + label: ๐Ÿ’ก Feature Description and Proposed Solution + description: Briefly describe your feature suggestion and how you envision it working. Include any mockups/screenshots if applicable. + placeholder: What's your brilliant idea? + validations: + required: true + - type: textarea + id: problem-related + attributes: + label: ๐Ÿค” Related Problem + description: Is your feature request related to a problem you're facing? + placeholder: Describe the problem, if applicable. The more we understand your struggle, the better we can address it. + validations: + required: false + - type: checkboxes + id: contribution + attributes: + label: ๐Ÿค Contribution + description: Would you be willing to contribute to this update? + options: + - label: Yes, I'd be happy to submit a pull request with these changes. + - label: I need some guidance on how to contribute. + - label: I'd prefer the AgentOps team to handle this update. + validations: + required: true \ No newline at end of file From 62facb536b0d8d80bb1177875a9b628e0853e455 Mon Sep 17 00:00:00 2001 From: reibs Date: Mon, 23 Sep 2024 19:23:51 -0700 Subject: [PATCH 3/4] updated contribution --- .github/CONTRIBUTING.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 74601edcd..dfd88cf75 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,15 +1,24 @@ -# Contributing Guide +## Open Source and Proprietary Components -Thank you for your interest in contributing to our project! +The AgentOps SDK is open source, but the backend and UI are not. We are source available and also support on-prem/VPC hosting upon request. -## Setting Up the Development Environment +That said, we love when community members contribute to our open source SDK-- we even mail over swag packs to developers who help out :) -Create a virtual environment `python -m venv env` and install requirements `pip install -e .` +## Contribution Guidelines -## Making a Pull Request +We use issues primarily to communicate our thoughts and plans to the community. However, not every issue is suitable for the open-source distribution, as some features may depend on non-open-source parts of our stack. -1. Fork the repository on GitHub. -2. Clone your forked repository to your local machine. -3. Make your changes and commit them to your forked repository. -4. Push your changes to your forked repository on GitHub. -5. Create a new pull request from your forked repository to our original repository. \ No newline at end of file +When looking for issues to work on look for following tags: +- `good first issue` +- `help wanted` + +If you have feature requests or bug reports, please open an issue. + +## Getting Started + +The easiest way to contribute is to start a conversation with us. We highly recommend: + +1. Joining our Discord community +2. Sending us a message through our contact form at [agentops.ai/contact](https://agentops.ai/contact) + +We look forward to collaborating with you and appreciate your interest in improving AgentOps! \ No newline at end of file From 933acbe323d7ffeb6157cba8d9a84b29c4f34524 Mon Sep 17 00:00:00 2001 From: reibs Date: Mon, 23 Sep 2024 19:25:02 -0700 Subject: [PATCH 4/4] update pr template --- .github/PULL_REQUEST_TEMPLATE.md | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index eb5b5cc3c..4afd238dd 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,8 @@ ## ๐Ÿ“ฅ Pull Request **๐Ÿ“˜ Description** -Briefly describe the changes you've made. - -**๐Ÿ”„ Related Issue (if applicable)** -If this PR is related to an existing issue, reference it here. - -**๐ŸŽฏ Goal** -Explain the intention behind this change. - -**๐Ÿ” Additional Context** -Any extra information or context to help us understand the change? +_Briefly describe the changes you've made._ **๐Ÿงช Testing** -Describe the tests you performed to validate your changes. +_Describe the tests you performed to validate your changes._ -Thank you for your contribution to Agentops!