Skip to content
Snippets Groups Projects
Select Git revision
  • master default protected
  • call-for-testing
  • single-core
  • cookbook-gui-fix
  • update-script
  • 0.4.1
  • 0.8.0
  • 0.7.0
  • 0.6.0
  • 0.5.0
  • 0.4.1
  • 0.3.5
  • 0.3.4
  • 0.3.3
  • 0.3.2
  • 0.3.1
  • 0.3.0
  • 0.2.0
  • 0.1.5
  • 0.1.4
  • 0.1.3
  • 0.1.2
  • 0.1.1
  • 0.1.0
  • 0.0.9
  • 0.0.8
26 results
Blame Permalink
Forked from redox-os / redox
3526 commits behind the upstream repository.
After you've reviewed these contribution guidelines, you'll be all set to contribute to this project.
CONTRIBUTING.md 10.23 KiB

Contributing to Redox

Thank you for your interest in contributing to Redox! This document is a guide to help newcomers contribute!
There are many ways to help us out and we appreciate all of them.

Index

Other External Links

Communication

Chat

The quickest and most open way to communicate with the Redox team is on our chat server. Currently, the only way to join it is by sending an email to info@redox-os.org, which might take a little while, since it's not automated. We're currently working on an easier way to do this, but this is the most convenient way right now.

Reddit

You can find Redox on Reddit in /r/rust/ and /r/redox/. The weekly update news is posted on the former.

Direct Contributing

Low-Hanging Fruit - Easy Targets for Newbies

  • 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)

  • Writing unit tests (may require minimal knowledge of rust)

  • If you are fluent in Rust, but not OS Development:

  • Apps development

  • Shell (Ion) development

  • Package manager (Magnet) development

  • Other high-level code tasks

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

  • Improve and optimize code, especially in the kernel

GitHub Issues

A bit more formal way of communication with fellow Redox devs, but a little less quick and convenient like the chat (unless of course you aren't in it yet, which if you're going to be involved in this project really at all, it is recommended that you request to join). These are for more specific topics.

Pull Requests

It's completely okay to just submit a small pull request without first making an issue or something, but if it's a significant change that will require a lot of planning and reviewing, it's best you start with writing an issue first. Also see git guidelines

Creating a Pull Request

  1. Fork the repository
  2. Clone the original repository to your local PC using one of the following commands based on the protocol you are using: