diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..da9f004 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,42 @@ +--- +name: Bug report +about: Report a reproducible problem in Devaulty +title: "[Bug]: " +labels: bug +assignees: "" +--- + +## Description + +Describe the problem clearly and concisely. + +## Steps to reproduce + +1. +2. +3. + +## Expected behavior + +What did you expect to happen? + +## Actual behavior + +What happened instead? Include the exact error message when applicable. + +## Environment + +- Devaulty version: +- Operating system and version: +- Installation method (release package or source): +- Relevant component (frontend, backend, MCP, other): + +## Logs and screenshots + +Add relevant logs, stack traces, or screenshots here. Remove passwords, tokens, +private keys, database URLs, and other sensitive information before posting. + +## Additional context + +Add any other context that may help reproduce or understand the problem. + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..045ae5b --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,35 @@ +## Summary + +Describe what this pull request changes and why. + +## Related issue + +Closes # + +## Type of change + +- [ ] Bug fix +- [ ] New feature +- [ ] Refactor or maintenance +- [ ] Documentation +- [ ] Other (describe below) + +## How was this tested? + +Describe the commands and scenarios used to validate the change. + +## Checklist + +- [ ] I have read `CONTRIBUTING.md`. +- [ ] The change is focused and does not include unrelated refactors. +- [ ] I added or updated documentation when needed. +- [ ] I added or updated tests when the behavior requires it. +- [ ] I ran the relevant existing checks locally. +- [ ] I did not include secrets, credentials, personal data, or generated build artifacts. +- [ ] I understand the code I am submitting and reviewed all AI-assisted output, if any. +- [ ] I disclosed significant AI assistance that affected the design or implementation, if applicable. + +## Screenshots or recordings + +Add screenshots or recordings for visual changes. Remove sensitive information +before posting. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..060e759 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,84 @@ +# Contributing to Devaulty + +Thank you for your interest in contributing to Devaulty. Contributions are +welcome through issues and pull requests that improve the application, its +security, documentation, or developer experience. + +## Read the project documentation first + +Before contributing, read the documentation in [`/docs`](docs/). It contains +important project rules, architectural decisions, security guidance, and +conventions that contributors are expected to follow. + +At minimum, review: + +- [`docs/architecture/`](docs/architecture/) for architectural decisions and + project conventions; +- [`docs/security/`](docs/security/) for security and sensitive-data guidance; +- the relevant [`backend/README.md`](backend/README.md) or + [`frontend/README.md`](frontend/README.md) for the area being changed. + +These documents are part of the project's technical record. If a contribution +changes an existing decision, convention, or security behavior, explain the +reason in the pull request and update the relevant documentation. + +## Before opening an issue + +- Search existing issues to avoid duplicates. +- Use the bug report template for reproducible bugs. +- Do not include passwords, API keys, private keys, vault contents, database + files, personal data, or other sensitive information. +- Do not report security vulnerabilities in a public issue. Use GitHub's + private vulnerability reporting when enabled, or contact the maintainers + privately before disclosing the issue. + +## Before opening a pull request + +1. Open or identify an issue for non-trivial changes. +2. Keep the pull request focused on one problem or feature. +3. Explain the motivation, implementation, and validation performed. +4. Update the relevant documentation when behavior, configuration, or + architecture changes. +5. Add or update tests when the change affects behavior. +6. Do not commit generated artifacts, local databases, IDE metadata, secrets, + or environment-specific files. + +## Development expectations + +- Follow the existing structure, naming, formatting, and patterns in the + repository. +- Prefer small, understandable changes over speculative refactors. +- Preserve Devaulty's local-first and security-focused behavior. +- Treat credentials and vault data as sensitive at all times. +- A pull request must pass the repository's existing CI checks before merging. + +## AI-assisted development + +AI tools may be used as development aids, but blindly submitting generated +code is not acceptable. Do not submit "vibe-coded" changes that you cannot +explain, test, maintain, or defend. + +Contributors are responsible for: + +- reviewing every AI-generated suggestion before committing it; +- understanding the security and behavioral impact of the submitted code; +- verifying dependencies, licenses, and copied snippets; +- writing or running appropriate tests and checks; +- disclosing meaningful AI assistance in the pull request when it affected the + design or implementation. + +AI assistance does not replace code review, testing, or responsibility for the +contribution. + +## Commit and pull request guidance + +- Use a clear, imperative description for commits. +- Keep commits logically organized. +- Do not rewrite shared history after review has started unless coordinated + with the maintainers. +- Be respectful and constructive when reviewing or discussing contributions. + +## Questions + +If you are unsure whether a change fits the project, open a discussion or an +issue describing the goal before investing in a large implementation. diff --git a/README.md b/README.md index b6f5019..1a38ea0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- Devaulty Logo + Devaulty Logo

@@ -7,6 +7,7 @@

+ Overview • Download • Features • Security • @@ -21,6 +22,10 @@ Devaulty is a desktop application designed to help software developers organize Built with a **local-first** philosophy, Devaulty operates entirely offline. Your data never leaves your machine and is never sent to external servers or cloud services. +

+ Devaulty Showcase +

+ --- ## Security & Privacy @@ -66,6 +71,7 @@ If you want to contribute, inspect the codebase, or build Devaulty from source, - ⚙️ **[Backend Documentation](backend/README.md)** — Go architecture (Hexagonal), SQLite persistence, embedded migrations, and security handlers. - 🎨 **[Frontend Documentation](frontend/README.md)** — React, Vite, TypeScript, and Tauri v2 shell integration. +- 🤝 **[Contributing Guide](CONTRIBUTING.md)** — How to report bugs, prepare pull requests, and work safely with AI-assisted development. ## MCP Integration diff --git a/docs/assets/demo-showcase-opt.gif b/docs/assets/demo-showcase-opt.gif new file mode 100644 index 0000000..0ef8725 Binary files /dev/null and b/docs/assets/demo-showcase-opt.gif differ