KolibriOS/kolibrios
13
14
Fork 12
Code Issues 113 Pull Requests 16 Actions Projects 1 Releases Wiki Activity

Docs: Added licensing to contributing guide #198

Open
mxlgv wants to merge 1 commits from add-license-file-header-to-guide into main
pull from: add-license-file-header-to-guide
merge into: KolibriOS:main
Conversation 4 Commits 1 Files Changed 3 +12 -1
mxlgv commented 2025-04-04 10:30:19 +02:00
Owner
Copy Link

Also renamed COPYING.TXT to LICENSE

Also renamed COPYING.TXT to LICENSE
mxlgv added 1 commit 2025-04-04 10:30:23 +02:00
Docs: Added licensing to contributing guide
All checks were successful
Build system / Check kernel codestyle (pull_request) Successful in 27s
Details
Build system / Build (pull_request) Successful in 12m40s
Details
1e663f36c8 
Also renamed COPYING.TXT to LICENSE

Signed-off-by: Max Logaev <maxlogaev@proton.me>
mxlgv added the
PR
Review required
Kind
Documentation
 labels 2025-04-04 10:30:53 +02:00
ace-dent commented 2025-04-04 18:23:50 +02:00
Member
Copy Link

I think we should have SPDX header details in a STYLE_GUIDE.md, linked to via CONTRIBUTING.

As per Discord:

Detailed SPDX comments in source files are encouraged by the REUSE software initiative from FSFE. It is also supported by the SPDX standard under Annex H. Although the suggestion is to put the Copyright field first, it seems more typical to place the license identifier first.

I think we should have SPDX header details in a `STYLE_GUIDE.md`, linked to via CONTRIBUTING. As per Discord: > Detailed SPDX comments in source files are encouraged by the [REUSE software](https://reuse.software) initiative from FSFE. It is also supported by the SPDX standard under[ Annex H](https://spdx.github.io/spdx-spec/v2.3/file-tags/). Although the suggestion is to put the Copyright field first, it seems more typical to place the license identifier first.
ace-dent commented 2025-04-07 09:25:44 +02:00
Member
Copy Link

I prepared a draft style guide in issue #202

I prepared a draft style guide in issue #202
Sweetbread requested changes 2025-04-15 17:36:29 +02:00
CONTRIBUTING.md
@@ -68,1 +68,4 @@
## Licensing
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:
Sweetbread commented 2025-04-15 17:29:24 +02:00
Owner
Copy Link

What does "need" mean? SHOULD or MUST I do?

What does "need" mean? SHOULD or MUST I do?
ace-dent commented 2025-04-15 22:12:42 +02:00
Member
Copy Link

Would you be more happy with wording I suggested in #202?

Would you be more happy with wording I suggested in #202?
CONTRIBUTING.md
@@ -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-only
Sweetbread commented 2025-04-15 17:28:15 +02:00
Owner
Copy Link

For what? There's LICENSE file already, so, by fraudulent, every file in this repo under GPLv2

For what? There's LICENSE file already, so, by fraudulent, every file in this repo under GPLv2
👍 1
dunkaist commented 2025-04-17 05:03:11 +02:00
Owner
Copy Link

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+.

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+.
👍 1
ace-dent commented 2025-04-30 16:35:23 +02:00
Member
Copy Link

I would encourage new code to move towards more permissive licenses, where possible.

I would encourage new code to move towards more permissive licenses, where possible.
CONTRIBUTING.md
@@ -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.
Sweetbread commented 2025-04-15 17:32:18 +02:00
Owner
Copy Link

Description of what? Of a program? Should I add a description to each its file?

Description of what? Of a program? Should I add a description to each its file?
ace-dent commented 2025-04-30 16:36:22 +02:00
Member
Copy Link

Yes. Ideally a one line description, where appropriate.

Yes. Ideally a one line description, where appropriate.
ace-dent commented 2025-04-30 16:32:22 +02:00
Member
Copy Link

Hey @mxlgv @dunkaist @Sweetbread can we agree how to move this forward? 🙏
My thoughts:

  1. Yes- change: COPYING.TXT to LICENSE. Make sure everything works with Docpack, etc. (may require to produce LICENSE.TXT at build time or simply add the extension ?)
  2. Simply make sure CONTRIBUTING points to a STYLE_GUIDE.
  3. Adopt (/modify) my suggestions for the style guide.
Hey @mxlgv @dunkaist @Sweetbread can we agree how to move this forward? 🙏 My thoughts: 1. Yes- change: `COPYING.TXT` to `LICENSE`. Make sure everything works with Docpack, etc. (may require to produce `LICENSE.TXT` at build time or simply add the extension ?) 2. Simply make sure CONTRIBUTING points to a STYLE_GUIDE. 3. Adopt (/modify) my suggestions for the style guide.
All checks were successful
Build system / Check kernel codestyle (pull_request) Successful in 27s
Required
Details
Build system / Build (pull_request) Successful in 12m40s
Required
Details
This pull request doesn't have enough required approvals yet. 0 of 2 official approvals granted.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
View command line instructions.

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin add-license-file-header-to-guide:add-license-file-header-to-guide
git checkout add-license-file-header-to-guide
Sign in to join this conversation.
Reviewers
No Reviewers
Sweetbread
Labels
Clear labels
C
Category/Applications
Category/Drivers
Category/General
Category/Kernel
Category/Libraries
Eolite
FASM
FS
GSoC
This issue in GSoC program
HardwareTested
HLL
Influence/Settings
Influence/Text/TYPO
IRCC
Kernel
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
Pay for the code
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
No Label
Kind
Documentation
PR
Review required
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
ace-dent Burer Doczom dunkaist IgorA Leency mxlgv ramenu rgimad sdongles Sweetbread
No Assignees
4 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: KolibriOS/kolibrios#198
No description provided.
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?