Add STYLE_GUIDE.md #202
Reference in New Issue
Block a user
No description provided.
Delete Branch "%!s()"
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?
We should start to provide a style guide for contributors, ideally in a
/docsfolder.It should be linked to from
CONTRIBUTING.md.Attached is a draft, standardising the file header.
If the Guide reaches acceptance/approval, it can also be the basis for introducing CI checks.
Edit: 7-Apr-2025 - Minor tweaks to example file.
@ace-dent You can formalize this in PR.
@mxlgv - I no longer have the ability to create PRs on Gitea. Perhaps you can incorporate into your open PR?
@ace-dent Is this a technical problem?
If you are well versed in licensing, your help would be helpful. I'm very bad at this. For example, I don’t know what to do with new applications. Do I need to add authorship or should everything be an abstract “KolibriOS team”. I also don’t understand in what case a person can add his own copyright to an existing one. Where is the line between fixing a bug and adding some major functionality?
I think the Copyright attribution should actually be
KolibriOS contributors(e.g. Am I in the 'team'?!).The use of
SPDX-FileCopyrightTextis more correct... but if the community strongly prefers standardCopyrightlines, thats ok by me.When to add one's own details to the copyright is a grey area. Lots of resource available online that discuss this. Ultimately I'd suggest we avoid adding more individuals than necessary. If I was writing an app in user space from scratch, I might reasonably want some direct attribution.
I believe, you are free to put either your own copyright or the KolibriOS Project Team copyright. If you decide to describe your code as the code by KolibriOS Project Team then you are considered a part of the team. We can't and shouldn't force people to replace their name with something like 'KolibriOS blah blah'. If a developer implements a feature they should be allowed to put their name on it, I believe.