From 6268e27099bc196f1fc181f17e46e616079977b7 Mon Sep 17 00:00:00 2001 From: Aleksei Simatov Date: Sun, 10 Dec 2023 23:52:41 +0400 Subject: [PATCH] Updated readme --- README.md | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index d303745..2d6690f 100644 --- a/README.md +++ b/README.md @@ -103,6 +103,17 @@ Explore how **pull-request-analytics-action** works with these report examples i Click the links for detailed report formats and insights. +## Detailed Report on Discussion Types + +To obtain a detailed report on the types of open discussions, it is necessary to include a specific label in the first message of each discussion, enclosed in double square brackets (`[[ ]]`). For example, use `[[Performance issue]]` to categorize a discussion as related to performance issues. The action will then provide a breakdown of discussions based on these labels, allowing for a more targeted and categorized analysis of discussion topics. + +**Example Usage**: + +- In the first comment of a pull request discussion, include a label like `[[Bug]]`, `[[Feature Request]]`, or any custom label of your choice. +- **pull-request-analytics-action** will recognize these labels and include them in the report, providing a categorized overview of discussions. + +This feature enhances the analytical capabilities of **pull-request-analytics-action**, offering a deeper insight into the nature and distribution of discussions in your pull requests. + ## Report Data Grouping, AMOUNT Parameter, and Time Calculation Logic - **Data Grouping**: The report data is organized based on the closure date of each pull request. @@ -146,20 +157,6 @@ Use these parameters to tailor the **pull-request-analytics-action** to your pro **pull-request-analytics-action** operates within GitHub's API rate limits and message size constraints, which are generally sufficient for detailed, long-term reporting. However, in rare cases of extremely large datasets, some adjustments might be necessary. For more information, refer to GitHub's documentation on [rate limiting](https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api). The length of the report generated by **pull-request-analytics-action** is limited to 65,536 characters due to GitHub Issue size constraints. -## Upcoming Features and Roadmap - -At **pull-request-analytics-action**, we are committed to continuous improvement and adding functionalities that enhance your experience and the utility of our tool. Here's a glimpse into some exciting features and enhancements planned for the near future: - -1. **Multi-Repository Reporting**: We are working on a feature that will allow users to compile reports across multiple repositories simultaneously. This will enable a more comprehensive analysis for teams managing multiple projects, providing a holistic view of their development activities. - -2. **Detailed Open PR Discussions and Review Analysis**: Understanding the quality and depth of discussions in PRs is crucial. We plan to introduce more detailed reporting on open PR discussions and code reviews, offering insights into the nature and effectiveness of team collaborations and feedback. - -3. **Enhanced Customization Options for Reports**: Recognizing the diverse needs of different teams, we aim to expand the customization capabilities of our reports. This enhancement will allow users to tailor reports more precisely to their specific requirements, ensuring that the reports are as relevant and informative as possible. - -These upcoming features are designed with your feedback and needs in mind, striving to make **pull-request-analytics-action** more adaptable, insightful, and supportive of your project management and development workflows. - -Stay tuned for these updates, and feel free to contribute your ideas or suggestions! - ## License **pull-request-analytics-action** is licensed under the [MIT License](https://opensource.org/licenses/MIT). This permits free use, modification, and distribution of the software, with the requirement of including the original copyright notice. For full license terms, see the [MIT License details](https://opensource.org/licenses/MIT).