addyosmani / addyosmani/git2txt

Add Option to Specify Repository Branch

未关闭
#4 0 条评论 4 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
JavaScript
星标
564
派生
58
PR 合并指标
30 天内没有已合并 PR

描述

Currently, git2txt defaults to the repository’s default branch when converting its contents into a text file. However, many repositories maintain multiple branches (e.g., develop, feature/*, release/*) that users might want to analyze or document separately. The ability to specify a branch would provide greater flexibility and control over which version of the repository is processed.

----

Introduce a new command-line option (e.g., --branch or -b) that allows users to specify the branch they wish to convert. For example:

```
git2txt username/repository --branch=develop
```

### Proposed Option Details:

* Option Name: --branch or -b
* Description: Specifies the branch of the repository to use for conversion.
* Default Behavior: If the option is not provided, the tool will continue to use the repository’s default branch.

```bash
# Specify the 'develop' branch
git2txt username/repository --branch=develop

# Using the short flag
git2txt username/repository -b feature/new-feature
```

Benefits:
* Flexibility: Users can choose which branch to convert, enabling analysis of different development stages.
* Efficiency: Facilitates working with repositories that have active development on multiple branches without needing to switch branches manually.
* Enhanced Functionality: Aligns git2txt with common Git workflows, making it more versatile for various use cases.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。