Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (37 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

58 lines (37 loc) · 1.21 KB

Contributing to OneThing

First off, thanks for considering contributing to OneThing.

This project is primarily a personal productivity tool designed to help maintain focus on long-term software projects. Contributions are welcome if they align with the project's philosophy and scope.

Project Philosophy

Before contributing, please understand the core goals of OneThing:

  • Focus on one primary project at a time
  • Maintain minimal and distraction-free design
  • Keep the app offline-first
  • Avoid feature creep
  • Prefer simplicity over cleverness

If a feature adds complexity without improving clarity or usability, it will likely be rejected.

Ways to Contribute

You can contribute by:

  • Reporting bugs
  • Suggesting workflow improvements
  • Improving documentation
  • Refactoring code for clarity
  • Adding well-scoped features aligned with project goals

Before You Start

Please:

  1. Check existing issues and pull requests
  2. Open an issue before implementing large changes
  3. Discuss architectural or major UI changes first

Development Setup

Prerequisites

  • Node.js
  • npm or pnpm
  • Basic knowledge of Svelte

Running the Project

npm install
npm run dev