-
Notifications
You must be signed in to change notification settings - Fork 178
/
Copy pathconf.toml
172 lines (155 loc) · 6.98 KB
/
conf.toml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# OpenAI API Settings
[api]
endpoint = "https://api.openai.com/v1/chat/completions"
engine = "gpt-3.5-turbo"
encoding = "cl100k_base"
rate_limit = 5
tokens = 669
tokens_max = 3899
temperature = 1.2
# Repository
[git]
repository = "https://github.com/eli64s/readme-ai"
name = "readme-ai"
# Paths
[paths]
badges = "conf/svg/badges_compressed.json"
dependency_files = "dependency_files.toml"
ignore_files = "ignore_files.toml"
language_names = "language_names.toml"
language_setup = "language_setup.toml"
readme = "readme-ai.md"
# Prompts
[prompts]
code_summary = """Offer a comprehensive summary that encapsulates the core functionalities of the provided code snippet:
\n{}\n Aim for precision and conciseness in your explanation, ensuring a fine balance between detail and brevity.
Limit your response to a maximum of 350 characters (including spaces).
"""
features = """Hello! Analyze the Git codebase {} and create a robust summary of the project's features.
The following information summarizes each file in the repository to help you get started: \n{}\n
Please provide a comprehensive technical analysis of the codebase and its components.
Consider the codebase as a whole and highlight the key characteristics, design patterns, architectural decisions, and any other noteworthy elements.
Generate your response as a Markdown table with the following columns:
| Feature | Description |
| ---------------------- | ------------------------------------- |
| **⚙️ Architecture** | Analyze the structural design of the system here. Limit your response to a maximum of 200 characters. |
| **📖 Documentation** | Discuss the quality and comprehensiveness of the documentation here. Limit your response to a maximum of 200 characters. |
| **🔗 Dependencies** | Examine the external libraries or other systems that this system relies on here. Limit your response to a maximum of 200 characters. |
| **🧩 Modularity** | Discuss the system's organization into smaller, interchangeable components here. Limit your response to a maximum of 200 characters. |
| **✔️ Testing** | Evaluate the system's testing strategies and tools here. Limit your response to a maximum of 200 characters. |
| **⚡️ Performance** | Analyze how well the system performs, considering speed, efficiency, and resource usage here. Limit your response to a maximum of 200 characters. |
| **🔐 Security** | Assess the measures the system uses to protect data and maintain functionality here. Limit your response to a maximum of 200 characters. |
| **🔀 Version Control** | Discuss the system's version control strategies and tools here. Limit your response to a maximum of 200 characters. |
| **🔌 Integrations** | Evaluate how the system interacts with other systems and services here. Limit your response to a maximum of 200 characters. |
| **📶 Scalability** | Analyze the system's ability to handle growth here. Limit your response to a maximum of 200 characters. |
Thank you for your time and effort!
"""
overview = """Please analyze the codebase located at {} and provide a robust, yet succinct overview of the rpoject.
The following includes a list of the summaries of the files in the repository: \n{}\n
Craft 3-4 sentences that encapsulate the core functionalities of the project, its purpose, and its value proposition.
"""
slogan = "Conceptualize a catchy and memorable slogan for the GitHub project: {}. Limit your response to 80 characters."
# Markdown Templates
[md]
default = "`ℹ️ INSERT-DESCRIPTION`"
dropdown = """<details closed><summary>{}</summary>\n\n{}\n\n</details>\n"""
header = """<div align="center">
<h1 align="center">
<img src="https://raw.githubusercontent.com/PKief/vscode-material-icon-theme/ec559a9f6bfd399b82bb44393651661b08aaf7ba/icons/folder-markdown-open.svg" width="100" />
<br>{}
</h1>
<h3>◦ {}</h3>
<h3>◦ Developed with the software and tools listed below.</h3>
"""
badges = """<p align="center">
{0}
</p>
<img src="https://img.shields.io/github/languages/top/{1}?style&color=5D6D7E" alt="GitHub top language" />
<img src="https://img.shields.io/github/languages/code-size/{1}?style&color=5D6D7E" alt="GitHub code size in bytes" />
<img src="https://img.shields.io/github/commit-activity/m/{1}?style&color=5D6D7E" alt="GitHub commit activity" />
<img src="https://img.shields.io/github/license/{1}?style&color=5D6D7E" alt="GitHub license" />
</div>
\n---
"""
toc = """
## 📒 Table of Contents
- [📒 Table of Contents](#-table-of-contents)
- [📍 Overview](#-overview)
- [⚙️ Features](#-features)
- [📂 Project Structure](#project-structure)
- [🧩 Modules](#modules)
- [🚀 Getting Started](#-getting-started)
- [🗺 Roadmap](#-roadmap)
- [🤝 Contributing](#-contributing)
- [📄 License](#-license)
- [👏 Acknowledgments](#-acknowledgments)
\n---
"""
intro = """
\n## 📍 Overview
\n{}
\n---
\n## ⚙️ Features
\n{}
\n---
"""
tree = """
\n## 📂 Project Structure\n
"""
modules = """
\n---
\n## 🧩 Modules
"""
setup = """---
\n## 🚀 Getting Started
\n### ✔️ Prerequisites
\nBefore you begin, ensure that you have the following prerequisites installed:
> - `ℹ️ Requirement 1`
> - `ℹ️ Requirement 2`
> - `ℹ️ ...`
\n### 📦 Installation
\n1. Clone the {0} repository:
```sh\ngit clone {1}\n```
\n2. Change to the project directory:
```sh\ncd {0}\n```
\n3. Install the dependencies:
```sh\n{2}\n```
\n### 🎮 Using {0}
\n```sh\n{3}\n```
\n### 🧪 Running Tests
```sh\n{4}\n```
\n---
"""
ending = """
\n## 🗺 Roadmap
> - [X] `ℹ️ Task 1: Implement X`
> - [ ] `ℹ️ Task 2: Refactor Y`
> - [ ] `ℹ️ ...`
\n---
## 🤝 Contributing
Contributions are always welcome! Please follow these steps:
1. Fork the project repository. This creates a copy of the project on your account that you can modify without affecting the original project.
2. Clone the forked repository to your local machine using a Git client like Git or GitHub Desktop.
3. Create a new branch with a descriptive name (e.g., `new-feature-branch` or `bugfix-issue-123`).
```sh
git checkout -b new-feature-branch
```
4. Make changes to the project's codebase.
5. Commit your changes to your local branch with a clear commit message that explains the changes you've made.
```sh
git commit -m 'Implemented new feature.'
```
6. Push your changes to your forked repository on GitHub using the following command
```sh
git push origin new-feature-branch
```
7. Create a new pull request to the original project repository. In the pull request, describe the changes you've made and why they're necessary.
The project maintainers will review your changes and provide feedback or merge them into the main branch.
---
## 📄 License
This project is licensed under the `ℹ️ INSERT-LICENSE-TYPE` License. See the [LICENSE](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository) file for additional info.
---
## 👏 Acknowledgments
> - `ℹ️ List any resources, contributors, inspiration, etc.`
---
"""