From cbd5868956e522994357d7b8b6ca5797603fcb41 Mon Sep 17 00:00:00 2001 From: Ribbon Date: Tue, 28 Feb 2023 21:05:55 +0000 Subject: [PATCH 1/4] Move section from book and new section. --- CONTRIBUTING.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cadd29b..0fd81bf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,7 +55,35 @@ Please follow our process for [creating proper pull requests](https://doc.redox- ## Low-Hanging Fruit - Easy Targets for Newbies -- [Redox Book Guide](https://doc.redox-os.org/book/ch10-02-low-hanging-fruit.html) +If you're not fluent in Rust: + + * Writing documentation + * Using/testing Redox, filing issues for bugs and needed features + * Web development ([Redox website, separate repo](https://gitlab.redox-os.org/redox-os/website)) + * Writing unit tests (may require minimal knowledge of rust) + +If you are fluent in Rust, but not OS Development: + + * Port applications written in Rust to Redox + * Rewritten-in-Rust libc ([relibc](https://gitlab.redox-os.org/redox-os/relibc)) + * Shell ([Ion](https://gitlab.redox-os.org/redox-os/ion)) + * Package manager ([pkgutils](https://gitlab.redox-os.org/redox-os/pkgutils)) + +If you are fluent in Rust, and have experience with OS Dev: + + * Familiarize yourself with the repository and codebase + * Grep for `TODO`, `FIXME`, `BUG`, `UNOPTIMIZED`, `REWRITEME`, `DOCME`, and `PRETTYFYME` and fix the code you find. + * Update older code to remove warnings. + * Improve and optimize code, especially in the kernel + +For those who want to contribute to the Redox GUI, our GUI strategy has recently changed. + + * OrbTk is now sunsetting, and its developers have moved to other projects such as the ones below. There is currently no Redox-specific GUI development underway. + * Redox is in the process of adopting other Rust-lang GUIs such as [Iced](https://iced.rs) and [Slint](https://slint-ui.com/). Please check out those projects if this is your area of interest. + +## Book ToDos + +- [Book README](https://gitlab.redox-os.org/redox-os/book/-/blob/master/README.md) ## Best Practices and Guidelines From 0d8656c3e4ba7f08a4d9d4732bead9e5788f4d66 Mon Sep 17 00:00:00 2001 From: Ribbon Date: Tue, 28 Feb 2023 23:53:52 +0000 Subject: [PATCH 2/4] Improve organization and cleanup. --- CONTRIBUTING.md | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0fd81bf..a34bbb2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,19 +7,10 @@ _**Thank you for your interest in contributing to Redox!** This document will ou - [Code Of Conduct](#code-of-conduct) - [License](#license) - [Communication](#communication) - - [Chat](#chat) - - [GitLab Issues](#gitlab-issues) - - [Pull Requests](#pull-requests) - [Low-Hanging Fruit - Easy Targets for Newbies](#low-hanging-fruit-easy-targets-for-newbies) - [Best Practices/Guidelines](#best-practices-and-guidelines) - - [General](#general) - - [Testing Practices](#testing-practices) - [Style Guidelines](#style-guidelines) - - [Rust](#rust) - - [Git](#git) - [Other Ways to Contribute](#other-ways-to-contribute) - - [Design](#design) - - [Donate to Redox](#donate-to-redox) ## Other External Links @@ -81,10 +72,6 @@ For those who want to contribute to the Redox GUI, our GUI strategy has recently * OrbTk is now sunsetting, and its developers have moved to other projects such as the ones below. There is currently no Redox-specific GUI development underway. * Redox is in the process of adopting other Rust-lang GUIs such as [Iced](https://iced.rs) and [Slint](https://slint-ui.com/). Please check out those projects if this is your area of interest. -## Book ToDos - -- [Book README](https://gitlab.redox-os.org/redox-os/book/-/blob/master/README.md) - ## Best Practices and Guidelines - [Redox Book Guide](https://doc.redox-os.org/book/ch11-00-best-practices.html) @@ -107,6 +94,10 @@ Please follow [how to create a proper pull request](https://doc.redox-os.org/boo If you're not big on coding, but you still want to help keep the project going, you can still contribute/support in a variety of ways! We'll try to find a way to use anything you have to offer. +### Book ToDos + +- [Book README](https://gitlab.redox-os.org/redox-os/book/-/blob/master/README.md) + ### Design If you're a good designer, whether it's _2D graphics, 3D graphics, interfaces, web design, you can help. We need logos, UI design, UI skins, app icons, desktop backgrounds, etc_. More information to come on this in the future, for now just join the [Chat](https://doc.redox-os.org/book/ch13-01-chat.html) and ask about graphic design. From 74316e71e9a3a22b78b607c130e1ada370c95f7f Mon Sep 17 00:00:00 2001 From: Ribbon Date: Wed, 1 Mar 2023 00:07:12 +0000 Subject: [PATCH 3/4] More cleanup of CONTRIBUTING. --- CONTRIBUTING.md | 57 +++++++++++++++++++++---------------------------- 1 file changed, 24 insertions(+), 33 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a34bbb2..fb5ebb9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,22 +2,6 @@ _**Thank you for your interest in contributing to Redox!** This document will outline the basics of where to start if you wish to contribute to the project. There are many ways to help us out and and we appreciate all of them. We look forward to **your contribution**!_ -## Index - -- [Code Of Conduct](#code-of-conduct) -- [License](#license) -- [Communication](#communication) -- [Low-Hanging Fruit - Easy Targets for Newbies](#low-hanging-fruit-easy-targets-for-newbies) -- [Best Practices/Guidelines](#best-practices-and-guidelines) -- [Style Guidelines](#style-guidelines) -- [Other Ways to Contribute](#other-ways-to-contribute) - -## Other External Links - -* [redox-os.org](https://redox-os.org) -* [rust-os-comparison](https://github.com/flosse/rust-os-comparison) -* [rust-lang.org](http://rust-lang.org) - ## Code Of Conduct We follow the [Rust Code Of Conduct](https://www.rust-lang.org/policies/code-of-conduct). @@ -28,22 +12,6 @@ All contributions are under the MIT license. - [Our Philosophy](https://doc.redox-os.org/book/ch01-02-philosophy.html) -## Communication - -### Chat - -Join us on [Matrix Chat](https://doc.redox-os.org/book/ch13-01-chat.html) to discuss issues or ask questions. - -### GitLab Issues - -You will need to have a Redox GitLab account to file an issue, and registration can take a few days. - -- [Redox Book Guide](https://doc.redox-os.org/book/ch13-03-gitlab-issues.html) - -### Pull Requests - -Please follow our process for [creating proper pull requests](https://doc.redox-os.org/book/ch12-04-creating-proper-pull-requests.html). - ## Low-Hanging Fruit - Easy Targets for Newbies If you're not fluent in Rust: @@ -88,7 +56,30 @@ Since **Rust** is a relatively small and new language compared to others like _C ### Git -Please follow [how to create a proper pull request](https://doc.redox-os.org/book/ch12-04-creating-proper-pull-requests.html). +Please follow our [Git style for pull requests](https://doc.redox-os.org/book/ch12-04-creating-proper-pull-requests.html). + +## GitLab + +### Issues + +You will need to have a Redox GitLab account to file an issue, and registration can take a few days. + +- [Redox Book Guide](https://doc.redox-os.org/book/ch13-03-gitlab-issues.html) + +### Pull Requests + +Please follow our process for [creating proper pull requests](https://doc.redox-os.org/book/ch12-04-creating-proper-pull-requests.html). + + +## External Links + +* [redox-os.org](https://redox-os.org) +* [rust-os-comparison](https://github.com/flosse/rust-os-comparison) +* [rust-lang.org](http://rust-lang.org) + +## Chat + +Join us on [Matrix Chat](https://doc.redox-os.org/book/ch13-01-chat.html) to discuss issues or ask questions. ## Other Ways to Contribute From 2eb18ab097c567829bd7352006a8fbf1300d7316 Mon Sep 17 00:00:00 2001 From: Ribbon Date: Wed, 1 Mar 2023 04:22:45 +0000 Subject: [PATCH 4/4] Move a list of repositories from Community website page. --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fb5ebb9..8ec7627 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,6 +40,21 @@ For those who want to contribute to the Redox GUI, our GUI strategy has recently * OrbTk is now sunsetting, and its developers have moved to other projects such as the ones below. There is currently no Redox-specific GUI development underway. * Redox is in the process of adopting other Rust-lang GUIs such as [Iced](https://iced.rs) and [Slint](https://slint-ui.com/). Please check out those projects if this is your area of interest. +You can contribute to Redox documentation/code on these repositories: + +(The order is based on difficulty, easy things first) + +- [Website](https://gitlab.redox-os.org/redox-os/website) +- [Book](https://gitlab.redox-os.org/redox-os/book) +- [Main Repository (build system/config)](https://gitlab.redox-os.org/redox-os/redox) +- [Cookbook (all system components/ported software)](https://gitlab.redox-os.org/redox-os/cookbook) +- [Display Server/Desktop Environment](https://gitlab.redox-os.org/redox-os/orbital) +- [Orbital Client Library](https://gitlab.redox-os.org/redox-os/orbclient) +- [Orbital Applications](https://gitlab.redox-os.org/redox-os/orbutils) +- [Redox C Library](https://gitlab.redox-os.org/redox-os/relibc) +- [Drivers](https://gitlab.redox-os.org/redox-os/drivers) +- [Kernel](https://gitlab.redox-os.org/redox-os/kernel) + ## Best Practices and Guidelines - [Redox Book Guide](https://doc.redox-os.org/book/ch11-00-best-practices.html)