chahuadev-dev-launcher / CONTRIBUTING.md
chahuadev's picture
Upload 5 files
135dbe6 verified

Contributing to Chahuadev Dev Launcher

Thank you for your interest in contributing! This guide explains how to get started.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

How to Contribute

Reporting Bugs

Before submitting a bug report, please:

  1. Check the existing issues to avoid duplicates.
  2. Include your OS version and app version (visible in window title or Help → About).
  3. Describe the steps to reproduce the issue and what you expected vs. what happened.

Suggesting Features

Open a GitHub issue with the label enhancement. Describe:

  • The problem your feature solves.
  • How you think it should work.
  • Any relevant mockups or examples.

Pull Requests

  1. Fork the repository and create a branch: git checkout -b feature/your-feature-name
  2. Make your changes and test them locally with npm start.
  3. Commit with a clear message: git commit -m "feat: describe your change"
  4. Push and open a Pull Request against main.

Before submitting a PR, ensure:

  • The app starts without errors (npm start)
  • No new console.error output in the main process
  • Any new IPC channel is validated in the main process
  • You have not introduced any security vulnerabilities (see SECURITY.md)

Commit Style

We use Conventional Commits:

Prefix Meaning
feat: New feature
fix: Bug fix
docs: Documentation only
refactor: Code restructure, no behaviour change
chore: Build / tooling changes
security: Security improvements

Development Setup

# Install dependencies
npm install

# Start in development mode
npm start

# Build distributables
npm run build

License

By contributing, you agree that your contributions will be licensed under the Chahuadev Sustainable Use License.