89 lines
3.2 KiB
Markdown
89 lines
3.2 KiB
Markdown
# Contributing to Redox
|
|
|
|
_**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)
|
|
- [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
|
|
|
|
* [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).
|
|
|
|
## License
|
|
|
|
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
|
|
|
|
- [Redox Book Guide](https://doc.redox-os.org/book/ch10-02-low-hanging-fruit.html)
|
|
|
|
## Best Practices and Guidelines
|
|
|
|
- [Redox Book Guide](https://doc.redox-os.org/book/ch11-00-best-practices.html)
|
|
|
|
### Testing Practices
|
|
|
|
- [Redox Book Guide](https://doc.redox-os.org/book/ch09-03-testing-practices.html)
|
|
|
|
## Style Guidelines
|
|
|
|
### Rust
|
|
|
|
Since **Rust** is a relatively small and new language compared to others like _C_, there's really only one standard. Just follow the official Rust standards for formatting, and maybe run `rustfmt` on your changes, until we setup the CI system to do it automatically.
|
|
|
|
### Git
|
|
|
|
Please follow [how to create a proper pull request](https://doc.redox-os.org/book/ch12-04-creating-proper-pull-requests.html).
|
|
|
|
## Other Ways to Contribute
|
|
|
|
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.
|
|
|
|
### 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.
|
|
|
|
### Donate to Redox
|
|
|
|
If you are interested in donating to the Redox OS nonprofit, you can find instructions [here](https://www.redox-os.org/donate/).
|