Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (44 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

71 lines (44 loc) · 1.47 KB

Contributing

We welcome contributions from the community! Please read this guide before submitting a pull request.

How to Contribute

1️⃣ Bug Fixes & Enhancements

  • Check for existing issues before opening a new one.
  • Submit a PR from a feature branch (not main).
  • Ensure your code follows existing TypeScript best practices.

2️⃣ Adding a New Feature

  • Open an issue first to discuss your approach.
  • If approved, create a new feature branch (feature/your-feature).
  • Implement tests if applicable.
  • Submit a pull request.

3️⃣ Creating a Custom Renderer

  • Contextr supports pluggable renderers.
  • Implement the Renderer interface:
export interface Renderer<T = unknown> {
  render(context: FileContext): T;
}

If your renderer is useful for others, submit it as a PR!

💡 Development Setup

  1. Clone the repo:
git clone https://github.com/7SigmaLLC/file-context-builder.git
cd file-context-builder
  1. Install dependencies:
npm install
  1. Run the example:
yarn example

This will generate a context snapshot of your code files to ./.context.out (git ignored), which can be fed into an LLM for analysis, refactoring, or intelligent suggestions.

⚖️ Code of Conduct

By contributing, you agree to uphold our Code of Conduct.

Thanks for your help in making File Context Builder better! 🚀

Back to README.md