Skip to content

Add MIT LICENSE file and update contributing documentation (fixes #2) - #7

Merged
koraytaylan merged 2 commits into
developfrom
issue-2-add-license
May 19, 2026
Merged

Add MIT LICENSE file and update contributing documentation (fixes #2)#7
koraytaylan merged 2 commits into
developfrom
issue-2-add-license

Conversation

@koraytaylan

Copy link
Copy Markdown
Owner

Summary

This PR resolves issue #2 by adding the missing open-source LICENSE and updating the contributing documentation to make the project's legal status clear.

Changes

  • Added LICENSE at repository root with the MIT License text (copyright holder: Koray Taylan, year 2025 as recommended).
  • Updated README.md:
    • Added [License](#license) entry to the Table of Contents.
    • Added explicit contributor licensing agreement sentence in the Contributing section.
    • Added a new ## License section at the end of the document linking to the LICENSE file.

Why MIT?

MIT is the recommended license per the issue: permissive, very short/easy to understand, the most common for Rust + Tauri + modern frontend projects, and compatible with almost every other open source license.

One sentence on the difference between MIT and Apache-2.0 (as required by acceptance criteria): MIT is shorter and more permissive with fewer formal requirements (no need to include NOTICE or patent grant language), lowering the barrier for individuals, small teams, and companies to use/adapt the code without extra legal review, whereas Apache-2.0 provides an explicit patent license grant and requires preserving NOTICE files which offers stronger patent protection for larger/commercial projects but adds minor compliance overhead.

Verification

  • ls -l LICENSE confirms the file exists at root.
  • GitHub will auto-detect the license and display the badge in the About section post-merge.
  • All changes are documentation-only; no code or tests impacted (Definition of Done documentation requirements satisfied by updating README).

Out of Scope (per issue)

  • License headers in source files (follow-up possible).
  • CLA or other legal docs.
  • Choosing non-MIT license (no discussion needed as MIT was pre-recommended).

Closes #2

- Added root LICENSE with standard MIT text (copyright 2025 Koray Taylan)
- Updated README.md Table of Contents, Contributing section (contributor agreement sentence), and added new License section at end
- Chose MIT for being permissive, simple, and common in Rust/Tauri/frontend projects
- One sentence on MIT vs Apache-2.0: MIT is shorter and more permissive (no patent grant or notice requirements like Apache-2.0), making it easier for individuals and companies to adopt without legal overhead, while still providing good protection; Apache-2.0 adds explicit patent license which is valuable for larger projects but adds complexity.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an MIT LICENSE file at the repository root and updates README.md to reference licensing terms, resolving issue #2 which flagged the absence of legal terms for the project.

Changes:

  • New LICENSE file with the MIT License text (Copyright 2025 Koray Taylan).
  • Added License entry to the README Table of Contents and a new ## License section at the end of the README.
  • Added a contributor licensing agreement sentence to the Contributing section.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
LICENSE New MIT License file at repo root.
README.md TOC entry, contributor licensing sentence in Contributing, and new License section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
…ion (per Copilot review on PR #7)

- The sentence was intentionally placed in Contributing per issue #2 spec.
- Kept it there; removed the redundant copy from the new ## License section.
- This addresses the single review comment about duplication.
- No other changes.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@koraytaylan
koraytaylan merged commit 33507e5 into develop May 19, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants