1- # Contributing to Context Generator
1+ # Contributing to ** CTX **
22
3- We're excited to welcome you as a contributor to the Context Generator project! This guide will help you get started
3+ We're excited to welcome you as a contributor to the ** CTX ** project! This guide will help you get started
44with contributing to our project.
55
66## How to Contribute
77
8- There are many ways to contribute to Context Generator :
8+ There are many ways to contribute to ** CTX ** :
99
10101 . ** Report Issues** : If you find a bug or have a
1111 suggestion, [ create an issue] ( https://github.com/context-hub/generator/issues ) on our GitHub repository.
12122 . ** Submit Pull Requests** : Have a fix or a new feature? Submit a pull request!
13133 . ** Improve Documentation** : Help us make our documentation more clear, comprehensive, and accessible.
14- 4 . ** Share Your Use Cases** : Let us know how you're using Context Generator in your projects.
14+ 4 . ** Share Your Use Cases** : Let us know how you're using ** CTX ** in your projects.
1515
1616We label issues that are suitable for community contribution with the ` help wanted ` tag. Additionally, we use labels
1717such as ` good first issue ` for newcomer-friendly tasks, and complexity indicators to help you choose tasks that match
1818your experience level.
1919
2020I'd be happy to write a better instruction for the Getting Started section that highlights the use of the context.yaml
21- file for context generation. This will help new contributors understand how they can use Context Generator itself to
21+ file for context generation. This will help new contributors understand how they can use ** CTX ** itself to
2222explore and work with the codebase.
2323
2424## Getting Started with Contributing
2525
26- Follow this guide to set up your environment and effectively contribute to the Context Generator project. We've designed
26+ Follow this guide to set up your environment and effectively contribute to the ** CTX ** project. We've designed
2727a workflow that leverages the tool's own capabilities to help you understand and improve the codebase.
2828
2929### 1. Set Up Your Environment
@@ -83,7 +83,7 @@ Run this configuration to generate a visual representation of the codebase struc
8383This will create a ` docs/file-structure.md ` file that outlines the project's organization. Just put this file in the
8484Claude project context to help it understand the codebase.
8585
86- ### 3. Explore the Codebase Using Context Generator
86+ ### 3. Explore the Codebase Using ** CTX **
8787
8888The project includes a pre-configured ` context.yaml ` file to help you explore the codebase:
8989
@@ -220,7 +220,7 @@ documents:
220220- Include relevant context files or excerpts
221221- Reference any related issues
222222
223- By using Context Generator in your contribution workflow, you'll not only improve the project but also gain firsthand
223+ By using **CTX** in your contribution workflow, you'll not only improve the project but also gain firsthand
224224experience with the tool while developing more effective collaboration patterns with AI assistants.
225225
226226## Areas Where Help Is Needed
@@ -232,12 +232,12 @@ We're particularly looking for help with:
232232- Creating specialized content modifiers for different languages
233233- Building integrations with popular IDEs and tools
234234
235- Your contributions, big or small, help make Context Generator a better tool for everyone. We look forward to
235+ Your contributions, big or small, help make **CTX** a better tool for everyone. We look forward to
236236collaborating with you!
237237
238238## Questions?
239239
240240If you have any questions about contributing, feel free to open an issue labeled "question" or reach out through the
241241[discussions](https://github.com/context-hub/generator/discussions) section on GitHub.
242242
243- Thank you for considering contributing to Context Generator !
243+ Thank you for considering contributing to **CTX** !
0 commit comments