Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (23 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

35 lines (23 loc) · 1.5 KB
Raw

Contributing to ConfigDev

First off, thank you for considering contributing to ConfigDev!

Since our primary focus is providing completely secure, local-first environments for developers, we value bug reports, security audits, and feature requests immensely.

🐛 Reporting Bugs

If you find a bug, a regex false-positive in our PII scrubber, or a UI issue, please open an issue in our repository.

When reporting a bug, please include:

  1. A clear and descriptive title.
  2. The exact steps to reproduce the issue.
  3. What you expected to happen vs what actually happened.
  4. If applicable, the browser and OS you are using.

Note: Please do not include actual sensitive logs or real PII in your bug reports. Always use dummy data!

💡 Suggesting Features

We love new ideas for local-first developer tools! If you have a suggestion:

  1. Check existing issues to see if it has already been suggested.
  2. Open a new issue with the label enhancement.
  3. Describe the problem your tool would solve and how it fits into the "Local-First, Privacy-First" philosophy.

🛠️ Pull Requests

While we might not be accepting large feature pull requests from the community just yet, if you spot a typo or a minor bug fix, feel free to open a PR!

  1. Fork the repo.
  2. Create a new branch (git checkout -b fix/your-fix).
  3. Make your changes (ensure they do not violate the local-first rule—no external API calls!).
  4. Push to your branch and submit a Pull Request.

Thank you for helping keep developers secure!