Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (32 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

45 lines (32 loc) · 1.2 KB
Raw

Contributing to Poopmail

Thank you for your interest in contributing to Poopmail!

Note: The main purpose of this project has been achieved and active development by the original author is paused. However, we welcome contributions from the community!

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally.
  3. Install dependencies: 
    cd frontend
pnpm install

Development

The project uses Qwik for the frontend and Cloudflare Workers for the email handling.

To run the frontend dev server:

cd frontend
pnpm dev

Submitting Changes

  1. Create a new branch for your feature or bugfix.
  2. Make your changes.
  3. Run the linter/formatter to ensure code style consistency: 
    pnpm fmt
  4. Commit your changes with descriptive commit messages.
  5. Push to your fork and submit a Pull Request.

Guidelines

  • Privacy First: Ensure any changes maintain the strict no-data-collection policy.
  • Keep it Simple: The service is designed to be minimal and fast.
  • Respect the Code of Conduct: Be kind and respectful to other contributors.

Thank you for helping improve Poopmail!