Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
133 lines (96 loc) · 3.25 KB

CONTRIBUTING.md

File metadata and controls

133 lines (96 loc) · 3.25 KB
Raw

Contributing to Secura Vault

First off, thank you for considering contributing!
We welcome contributions of any kind: bug fixes, new features, documentation improvements, UI enhancements, or security suggestions.

Table of Contents

Code of Conduct

All contributors are expected to follow the Contributor Covenant Code of Conduct.
Be respectful, collaborative, and professional in all interactions.

How to Contribute

Reporting Issues

If you find a bug or have a suggestion:

  1. Check if the issue already exists.
  2. Open a new issue with a descriptive title and detailed steps to reproduce.
  3. Include screenshots or logs if relevant.

Labels: Use the appropriate label like bug, enhancement, or documentation.

Feature Requests

To propose a new feature:

  1. Open an issue with the [Feature Request] prefix.
  2. Describe the problem and why it’s important.
  3. Suggest a solution or approach if possible.

Pull Requests

We use Pull Requests (PRs) for all contributions.

  1. Fork the repository and create a branch:
git checkout -b feature/my-new-feature
  1. Make your changes and ensure they follow coding guidelines.
  2. Run tests to make sure nothing is broken.
  3. Commit your changes with a clear message:
git commit -m "feat: add new secret type handling"
  1. Push your branch to your fork:
git push origin feature/my-new-feature
  1. Open a PR against the main branch of this repository.

PR Template: Please follow the included PR template to provide context and motivation.

Development Setup

Prerequisites

  • Node.js >= 18
  • npm or yarn
  • Electron-compatible OS

Installation

git clone https://github.com/yourusername/secura.git
cd secura
npm install

Running

npm run dev

Building

npm run build
npm run package

Coding Guidelines

  • Language & Frameworks: TypeScript, React, Electron, TailwindCSS, Radix UI
  • File Naming: PascalCase.tsx for components, camelCase.ts for utils
  • Formatting: Prettier + ESLint enforced
  • State Management: Use Zustand for app state
  • IPC & Vault Calls: Always use window.vault.* or ipcRenderer.invoke via preload

Commit Messages

We follow the Conventional Commits style:

Type Description
feat new feature
fix bug fix
docs documentation only
style formatting, missing semi-colons
refactor code change without new features
test adding or updating tests
chore build process, dependencies

Example:

feat: add password strength meter to AddSecretModal

Thank you for helping make Secura Vault better and more secure!