Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (44 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

64 lines (44 loc) · 1.68 KB
Raw

Contributing to Findle

Thanks for your interest in contributing to Findle.

What Findle is

Findle is a native macOS app that brings Moodle / Open LMS course materials into Finder using Apple File Provider.

This project is currently focused on:

  • macOS
  • Moodle / Open LMS
  • Finder-native file workflows
  • stability, clarity, and secure auth flows

Before you contribute

Please open an issue before starting work on:

  • large refactors
  • new features
  • architectural changes
  • UI redesigns

Small bug fixes and documentation improvements can be submitted directly.

Development principles

When contributing, please try to preserve these goals:

  • keep the app native to macOS
  • prefer clarity over abstraction
  • avoid adding features that turn Findle into a full LMS client
  • keep Moodle / Open LMS support stable and well-tested
  • do not introduce unnecessary dependencies

Pull requests

Please make pull requests:

  • focused and small
  • clearly described
  • linked to an issue when relevant
  • tested locally before submission

Include:

  • what changed
  • why it changed
  • screenshots for visible UI changes
  • any migration or compatibility notes

Code style

Please follow the existing style of the codebase. Prefer incremental improvements over broad rewrites.

Licensing of contributions

By intentionally submitting a contribution to this repository, you agree that your contribution is licensed under the Apache License 2.0 for inclusion in this project.

Contributor expectations

By participating in this project, you agree to follow the Code of Conduct.

Security issues

Please do not open public issues for security vulnerabilities. Instead, follow the instructions in SECURITY.md.