diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e410e575f..918040586 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,19 +2,19 @@ ## Type of contributing -There are two main types of contributions accepted in KolibriOS: +There are two main types of contributions accepted to the main KolibriOS repository: - Submitting issues about problems in the project - Submitting code to the project via pull requests -Each of these types is described in detail below. +Both these types are described in detail below. ## Issues 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 Requests are used, when you want to propose some **improvement** to the system (missing features, improved user experience, etc.) ## Pull requests @@ -28,11 +28,11 @@ You can also help us by submitting code via pull requests. The process of submit 6. Create and submit a pull request into `main` branch 7. Wait for CI/CD pipelines and code review to pass -When 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. +When a pull request is submitted, at least two project participants must conduct a code review, after which the proposed changes need to be corrected (if requested) and merged into the project. ## Commit style -### Pattern +### Message pattern The commit message should look like this: @@ -68,4 +68,4 @@ Use **rebase** to keep your branch up to date. ## Conclusion -We 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. +We hope this small instructions will help you to get familiar with KolibriOS contribution rules and inspire you to participate in the life of our project. diff --git a/README.md b/README.md index 754bd9bdc..bde40a898 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,11 @@ [![License](https://img.shields.io/badge/License-GPL%202.0-green)](./COPYING.TXT) [![Build system](https://git.kolibrios.org/KolibriOS/kolibrios/actions/workflows/build.yaml/badge.svg)](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. +KolibriOS is a hobby operating system for x86-compatible computers, which is currently being developed by a small but passionate team 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 are written entirely in [FASM](https://flatassembler.net/) assembly language, making them 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 compliant +Based on [MenuetOS](https://www.menuetos.net/), it uses its own standards and is NOT fully POSIX or UNIX compliant. ## Contributing