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

Docs: Added README and contributing guide #124

Merged
mxlgv merged 9 commits from add-readme-contributing-code-of-conduct into main 2025-03-21 21:08:49 +01:00
Conversation 21 Commits 9 Files Changed 3 +11 -11
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 67e8871308 - Show all commits

22
CONTRIBUTING.md
View File

@@ -2,30 +2,30 @@
## Type of contributing
There are two main types of contributions, accepted in KolibriOS:
There are two main types of contributions accepted in KolibriOS:
Burer marked this conversation as resolved Outdated
dunkaist commented 2025-03-21 03:42:23 +01:00
Outdated
Review
Copy Link

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

> 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'.
- Submitting issues about problems in project
- Submitting code to project via pull requests
- Submitting issues about problems in the project
- Submitting code to the project via pull requests
Each of these types is described in details below.
Each of these types is described in detail below.
Burer marked this conversation as resolved Outdated
dunkaist commented 2025-03-21 03:47:38 +01:00
Outdated
Review
Copy Link

Each of these types is

Both these types are ?

> Each of these types is Both these types are ?
## Issues
You can help us by submitting issues about problems, found in system. Currently, there are two main ways of submitting an issue in the project: **Bug Reports** and **Feature Requests**:
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, inexcpected behaviour) in some part of the system (kernel, drivers, apps etc.) and want to report it
- Feature Request are used, when you wont to propose some **improvement** to the system (missing features, impoved user experience, etc.)
- 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.)
Burer marked this conversation as resolved Outdated
dunkaist commented 2025-03-21 03:50:55 +01:00
Outdated
Review
Copy Link

Feature Request

Feature Request_s_

improved user

improved user (only one space between the words)

> Feature Request Feature Request_s_ > improved user improved user (only one space between the words)
## Pull requests
You can also help us by submitting code via pull requests. The process of submitting a pull request consists of following steps:
You can also help us by submitting code via pull requests. The process of submitting a pull request consists of the following steps:
1. Find what you want to implement or improve
2. Make a fork of kolibrios repository
2. Make a fork of kolibrios (or other needed) repository
3. Create a branch with a name that matches your changes
4. Implement and test the changes
5. Create commits according to the [accepted style](##commit-style)
mxlgv marked this conversation as resolved Outdated
Sweetbread commented 2025-03-13 19:51:23 +01:00
Outdated
Review
Copy Link

Incorrect anchor link

Incorrect anchor link
Burer commented 2025-03-14 09:04:23 +01:00
Outdated
Review
Copy Link

Fixed.

Fixed.
6. Create and submit a pull request into main branch
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.
Burer marked this conversation as resolved Outdated
dunkaist commented 2025-03-21 03:54:45 +01:00
Outdated
Review
Copy Link

changes can be corrected (if it's necessary)

changes need to be corrected (if requested)

> changes can be corrected (if it's necessary) changes need to be corrected (if requested)
@@ -79,4 +79,4 @@ Libs/libimg
## Conclusion
We hope this small instructions will help you to can common with KolibriOS contributon 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 work of this project.