Docs: Added README and contributing guide #124
Leency
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: KolibriOS/kolibrios#124
Reference in New Issue
Block a user
No description provided.
Delete Branch "add-readme-contributing-code-of-conduct"
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?
f298c2d0f7to45b299d80c@@ -0,0 +4,4 @@## PurposeThe primary goal of our community is to be inclusive of a large number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, ability, ethnicity, socioeconomic status, and religion (or lack thereof)I believe the primary goal of our community is to develop KolibriOS, isn't it?
CoC has been removed.
@@ -0,0 +8,4 @@This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behaviorWe invite all those who participate in our community to help us create safe and positive experience for everyoneIf we require people to follow this CoC, then we should be honest and use words like force, enforce but not invite.
CoC has been removed.
@@ -0,0 +6,4 @@The primary goal of our community is to be inclusive of a large number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, ability, ethnicity, socioeconomic status, and religion (or lack thereof)This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behaviorThis document does not mention consequences.
CoC has been removed.
@@ -0,0 +41,4 @@- PatternRegular commit message should consist of several parts and be built according to the following template:Text seems like too formal
For example, instead of this, you can simply write smth like
Commit message should look likeetc
Fixed
@@ -0,0 +92,4 @@### SigningThis is not a requirement, but it is strongly recommended to sign commits. This can be done by the following command:Maybe you should in two words say why
Deleted. Not relevant for us: https://stackoverflow.com/questions/1962094/what-is-the-sign-off-feature-in-git-for
@@ -0,0 +55,4 @@- LengthThe maximum number of characters in a commit header is __72__ (standard for __Git__). Additionally, __72__ is the maximum length of a line in a commit body.Why not 50 and 72 like in Linux?
I thought about it but I didn't find any advantages. Rather, we limit ourselves.
45b299d80cto35f774b541Docs: Added README, contributing guide and code of conductto Docs: Added README and contributing guide35f774b541tod2856e033ed2856e033eto3cc3fa6689b5ff84abe1tod55f2055f2d55f2055f2to63264c83a3New commits pushed, approval review dismissed automatically according to repository settings
@@ -0,0 +37,4 @@The commit message should look like this:```test[Category] Commit message header->
commit type(category):commit messageTo Conventional Commit Messages
I have checked Linux, Qemu and GCC. They all do mention categories but in a plain format like 'category: Commit message'. I believe it would be easier for us to explain to people why they should follow a policy if it is the policy of Linux, Qemu and GCC rather than the one of Rishav Pandey.
https://www.conventionalcommits.org/en/v1.0.0/
I might be wrong but this looks like whishful thinking to me.
All the automatically generated changelogs I have seen are unreadable because you have to know the context first to understand them. They can be used if you want to have them as a formality only. But they won't be useful for users/developers as a dump of commit messages.
To what version in KolibriOS does this apply?
The nature of changes is described in any normal commit message.
Currently we build and publish on each push. What will this change?
I have never seen anybody using it.
If commit messages are descriptive, follow a consistent format, and include meaningful context, the generated changelog can be more useful.
Not neccessary the OS, but apps, libs and other software in it
The standart enforse to use types, which is better both for describing and searching in commit list
For example, not to build if the type is
docsNamida, antimicrox, AGS, yazi, bubbletea, pokete, Bagels, kaizen, fd
I wish we could eventually motivate people to write meaningful commit messages. Let be honest, forcing them to choose from 20 commit types it just too much, it won't work. What is surprisingly strange, the spec allows to shorten feature as feat but not performance as perf, no logic behind this.
The rebuild is needed is the docs are in the distro. Tup handles this automatically already. You don't need to manually control this via commit messages.
I have never heard of them. Linux, Qemu and GCC are more familiar to our potential developers, I believe.
What GCC uses, Linux seems to me really more attractive
@Sweetbread @dunkaist The adoption of a style for commits can take a long time (while we are discussing we don't have any documentation at all). This minimal documentation with very light rules should be enough for the community while it adapts to GIT. We can probably raise this issue in the future. But for now, let's not get hung up on it. This PR contains other changes as well.
New commits pushed, approval review dismissed automatically according to repository settings
New commits pushed, approval review dismissed automatically according to repository settings
@@ -0,0 +24,4 @@2. Make a fork of kolibrios (or other needed) repository3. Create a branch with a name that matches your changes4. Implement and test the changes5. Create commits according to the [accepted style](##commit-style)Incorrect anchor link
Fixed.
@@ -0,0 +21,4 @@The KolibriOS team expresses special thanks to the author of the 32-bit **MenuetOS**, [Ville Turjanmaa](https://www.menuetos.net/contact.htm). We also want to note that all **MenuetOS** copyrights have been preserved.## LicenseThe license is already written next to Build system section. It seems that this is not necessary.
@Burer @dunkaist @Sweetbread what do you think?
I agree that we can remove License here, as it as already preset at the top of README.
Fixed
0499ba2c51to16f627ed45@@ -0,0 +2,4 @@## Type of contributingThere are two main types of contributions accepted in KolibriOS:If we were talking about the entire KolibriOS then we should have mentioned documentation, testing, content creation, etc. Since we agreed in the telegram chat to write about this main repo only, let's change 'in KolibriOS' to 'to the main KolibriOS repository'.
@@ -0,0 +7,4 @@- Submitting issues about problems in the project- Submitting code to the project via pull requestsEach of these types is described in detail below.Both these types are ?
@@ -0,0 +14,4 @@You can help us by submitting issues about problems found in the system. Currently, there are two main ways of submitting an issue in the project: **Bug Reports** and **Feature Requests**:- Bug Reports are suitable if you find a **bug** (crash, error, unexpected behavior) in some part of the system (kernel, drivers, apps, etc.) and want to report it- Feature Request are used, when you want to propose some **improvement** to the system (missing features, improved user experience, etc.)Feature Request_s_
improved user (only one space between the words)
@@ -0,0 +28,4 @@6. Create and submit a pull request into `main` branch7. Wait for CI/CD pipelines and code review to passWhen a pull request is submitted, at least two project participants must conduct a code review, after which the proposed changes can be corrected (if it's necessary) and merged into the project.changes need to be corrected (if requested)
@@ -0,0 +32,4 @@## Commit style### PatternMessage pattern?
@@ -0,0 +68,4 @@## ConclusionWe hope this small instructions will help you to get familiar with KolibriOS contribution rules and inspire you to participate in the work of this project.instruction
familiar with (one space)
participate in the life of our project?
@@ -0,0 +3,4 @@[](./COPYING.TXT)[](https://git.kolibrios.org/KolibriOS/kolibrios/actions)KolibriOS is a hobby operating system for x86-compatible computers, which is currently being developed by a small teem of enthusiasts.small but passionate (!)
team
@@ -0,0 +5,4 @@KolibriOS is a hobby operating system for x86-compatible computers, which is currently being developed by a small teem of enthusiasts.It's kernel is written entirely in [FASM](https://flatassembler.net/) assembly language, making it very compact and lean on system resources.Its
kernel, most drivers and many programs
@@ -0,0 +7,4 @@It's kernel is written entirely in [FASM](https://flatassembler.net/) assembly language, making it very compact and lean on system resources.Based on [MenuetOS](https://www.menuetos.net/), it uses its own standards and is NOT fully POSIX or UNIX compliantcompliant. (dot)