Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.81 KB

File metadata and controls

54 lines (36 loc) · 1.81 KB

Contributing to CodingMation PDF Tools

Thanks for your interest in improving these tools. This project is a set of static, offline PDF micro-apps. Please keep that design in mind.

How to contribute

  1. Fork the repository
  2. Clone your fork
  3. Create a branch: git checkout -b feature/your-idea or fix/issue-description
  4. Make changes
  5. Test locally (see below)
  6. Commit with a clear message
  7. Push and open a Pull Request against main

Local testing

python3 -m http.server 8080

Open http://localhost:8080/ and exercise the tool you changed. ES modules require HTTP — do not use file://.

Guidelines

  • No backend — do not add server-side code, APIs, or required cloud processing
  • Privacy first — do not upload user files or add analytics that capture document content
  • Keep tools focused — each folder is one micro-tool; avoid merging unrelated flows
  • Match existing UI — reuse css/styles.css patterns (cards, buttons, spacing)
  • Vendor locally — if you add a library, place a minified build under vendor/ and load it from the page (no required CDN at runtime)
  • Accessibility — preserve keyboard use, labels, and focus styles where possible
  • Small PRs — easier to review than large multi-tool refactors

Reporting bugs

Open an issue with:

  • Browser and OS
  • Steps to reproduce
  • Expected vs actual behavior
  • Whether it happens offline / after hard refresh

Do not attach private PDFs or personal documents.

Feature ideas

Open an issue first for larger features so we can discuss scope (especially anything that might affect privacy or offline behavior).

Code of Conduct

By participating, you agree to follow our Code of Conduct.

License

Contributions are accepted under the MIT License.