Docs: Added licensing to contributing guide #198
Open
mxlgv
wants to merge 2 commits from
add-license-file-header-to-guide into main
pull from: add-license-file-header-to-guide
merge into: KolibriOS:main
KolibriOS:main
KolibriOS:reshare-tweak
KolibriOS:rewrite-piano
KolibriOS:blocks-add-models
KolibriOS:shell-improve-cpuid
KolibriOS:rewrite_ide_drv
KolibriOS:refactor/links
KolibriOS:add_usbother
KolibriOS:webview-3.91
KolibriOS:qrcodegen
KolibriOS:ci/update
KolibriOS:floppybird-window-fix
KolibriOS:laser-tank-fix-win-height
KolibriOS:improvement/commit-and-branch-styles
KolibriOS:docs/libs
Dismiss Review
Are you sure you want to dismiss this review?
Labels
Clear labels
C
Category/Applications
Category/Drivers
Category/General
Category/Kernel
Category/Libraries
Eolite
FASM
FS
GSoC
HardwareTested
HLL
Influence/Settings
Influence/Text/TYPO
IRCC
Kernel
Pay for the code
This issue in GSoC program
Kind
Breaking
Breaking change that won't be backward compatible
Kind
Bug
Something is not working
Kind
Build
Kind
Documentation
Documentation changes
Kind
Enhancement
Improve existing functionality
Kind
Feature
New functionality
Kind
Security
This is security issue
Kind
Testing
Issue or pull request related to testing
Paid task
PR
Conflicts
PR conflicts with main
PR
Dependent
This PR is dependent on another PR
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
PR
Ready to merge
Pull request is ready for merge
PR
Request changes
Changes requested in pull request
PR
Review required
Reviewed
Confirmed
Issue has been confirmed
Reviewed
Duplicate
This issue or pull request already exists
Reviewed
Invalid
Invalid issue
Reviewed
Won't Fix
This issue won't be fixed
Status
Abandoned
Somebody has started to work on this but abandoned work
Status
Blocked
Something is blocking this issue or pull request
Status
Need More Info
Feedback is required to reproduce issue or to continue work
Milestone
No items
No Milestone
Projects
Clear projects
No project
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: KolibriOS/kolibrios#198
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Delete Branch "add-license-file-header-to-guide"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Also renamed COPYING.TXT to LICENSE
I think we should have SPDX header details in a
STYLE_GUIDE.md, linked to via CONTRIBUTING.As per Discord:
I prepared a draft style guide in issue #202
@@ -68,1 +68,4 @@## LicensingFor new source code files and for existing ones without a license, you need to add the following header to the beginning of the file:What does "need" mean? SHOULD or MUST I do?
Would you be more happy with wording I suggested in #202?
@@ -69,0 +70,4 @@For new source code files and for existing ones without a license, you need to add the following header to the beginning of the file:```asm; SPDX-License-Identifier: GPL-2.0-onlyFor what? There's LICENSE file already, so, by fraudulent, every file in this repo under GPLv2
Each program can have its own licence. Sometimes even different files of a program can have different licences if compatible. For example, one kernel file can be GPL2-only while another GPL2+.
I would encourage new code to move towards more permissive licenses, where possible.
@@ -69,0 +71,4 @@For new source code files and for existing ones without a license, you need to add the following header to the beginning of the file:```asm; SPDX-License-Identifier: GPL-2.0-only; Program - Brief description.Description of what? Of a program? Should I add a description to each its file?
Yes. Ideally a one line description, where appropriate.
Hey @mxlgv @dunkaist @Sweetbread can we agree how to move this forward? 🙏
My thoughts:
COPYING.TXTtoLICENSE. Make sure everything works with Docpack, etc. (may require to produceLICENSE.TXTat build time or simply add the extension ?)@ace-dent @dunkaist Sorry, it seems this has stalled. The problem is that we simply don't have a specialist who understands these kinds of legal matters. I don't know what the proper procedure should be, especially for a multi-component project like an OS. Some components don't have licenses in their source code headers, which makes it even more complicated. I'm also not sure that the root LICENSE file applies to everything that doesn't have a license in their source code headers.
I can only rely on the authority of a large company: https://github.com/ARM-software/u-boot/tree/master/Licenses. They store licenses in a separate folder and use SPDX identifiers in file headers. I propose doing the same. What to do with unlicensed files remains an open question.
PS:
I'd like to add that, in fact, it seems like all native OS components are GPL-2.0. The problem only exists due to the thoughtless integration of ports into the monorepo.
1e663f36c8toaa3193b04fView command line instructions
Checkout
From your project repository, check out a new branch and test the changes.