Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
146 lines (101 loc) · 3.93 KB

CONTRIBUTING.md

File metadata and controls

146 lines (101 loc) · 3.93 KB
Raw
ZFordDev Standards Approved Badge

Contributing to ZFordDev Projects

Thank you for your interest in contributing!
All ZFordDev projects follow a shared set of standards designed to keep the ecosystem consistent, maintainable, and welcoming.

This document explains how to contribute code, documentation, bug reports, and feature requests across the ecosystem.

For ecosystem‑wide expectations, please read:

👉 STANDARDS.md
(Clarity • Simplicity • Maintainability • Long‑term stability)

Ways to Contribute

You can contribute in many ways:

  • Reporting bugs
  • Suggesting new features
  • Improving documentation
  • Submitting pull requests
  • Reviewing existing issues
  • Helping refine UX or workflows
  • Testing on different platforms

All contributions are appreciated — even small ones.

Code of Conduct

By participating in this project, you agree to follow:

👉 CODE_OF_CONDUCT.md

Respect, clarity, and constructive collaboration are core values of the ecosystem.

Before You Start

Please check:

  • The Issues tab for existing reports
  • The Roadmap (if present)
  • The Discussions tab for ongoing ideas
  • The STANDARDS.md file for ecosystem rules
  • The project‑specific section below for details unique to this repository

If you’re unsure whether an idea fits, open a Discussion first — it saves everyone time.

Pull Request Guidelines

To keep contributions consistent:

  1. Fork the repository
  2. Create a feature branch
    • feature/your-feature-name
    • fix/your-bug-name
  3. Keep PRs focused
    • One feature or fix per PR
    • Avoid unrelated formatting changes
  4. Follow the coding style of the project
    • Naming conventions
    • File structure
    • Module layout
  5. Test your changes
    • Ensure the app builds
    • Ensure no regressions
  6. Write clear commit messages
    • Present tense
    • Short and descriptive
  7. Describe your PR clearly
    • What changed
    • Why it changed
    • Any side effects or considerations

Small, focused PRs are easier to review and merge.

Reporting Bugs

When reporting a bug, please include:

  • OS and version
  • App version
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Screenshots or logs (if helpful)

Clear reports help us fix issues faster.

Suggesting Features

Feature requests should:

  • Explain the problem, not just the solution
  • Describe the use case
  • Fit the project’s philosophy (see STANDARDS.md)
  • Avoid scope creep or IDE‑level complexity

If unsure, open a Discussion first.

Project‑Specific Guidelines

Each project may have additional rules, workflows, or architectural notes.

SnapDock‑Specific Notes

  • UI changes should follow the existing theme structure
  • Markdown rendering changes must not break CoffeeMD compatibility (once integrated)
  • Electron updates should be tested on both Windows and Linux when possible
  • Avoid adding heavy dependencies — keep the app lightweight
  • Follow the existing module layout in src/modules/
  • Keep the editor experience simple, predictable, and distraction‑free
  • Avoid introducing IDE‑style complexity or plugin systems
  • Ensure new features align with the “minimal, modern, stable” philosophy of SnapDock

Thank You

Your contributions help strengthen the entire ZFordDev ecosystem.
Whether you’re fixing a typo or building a major feature — you’re part of the project’s future.