3.9 KiB

Raw Blame History

Contributing

Welcome stranger!

If you have come here to learn how to contribute to mdBook, we have some tips for you!

First of all, don't hesitate to ask questions! Use the issue tracker, no question is too simple. If we don't respond in a couple of days, ping us @azerupi, @steveklabnik, @frewsxcv it might just be that we forgot. 😉

Issues to work on

Any issue is up for the grabbing, but if you are starting out, you might be interested in the E-Easy issues. Those are issues that are considered more straightforward for beginners to Rust or the codebase itself. These issues can be a good launching pad for more involved issues. Simple documentation improvements are also very highly appreciated!

If you come from a web development background, you might be interested in issues related to web technologies tagged A-JavaScript, A-Style, A-HTML or A-Mobile.

When you decide you want to work on a specific issue, ping us on that issue so that we can assign it to you. Again, do not hesitate to ask questions. We will gladly mentor anyone that want to tackle an issue.

Issues on the issue tracker are categorized with the following labels:

A-prefixed labels state which area of the project an issue relates to.
E-prefixed labels show an estimate of the experience necessary to fix the issue.
M-prefixed labels are meta-issues used for questions, discussions, or tracking issues
S-prefixed labels show the status of the issue
T-prefixed labels show the type of issue

Building mdBook

mdBook builds on stable Rust, if you want to build mdBook from source, here are the steps to follow:

Navigate to the directory of your choice

Clone this repository with git.

git clone https://github.com/azerupi/mdBook.git

Navigate into the newly created mdBook directory
Run cargo build

The resulting binary can be found in mdBook/target/debug/ under the name mdBook or mdBook.exe.

Making changes to the style

mdBook doesn't use CSS directly but uses Stylus, a CSS-preprocessor which compiles to CSS.

When you want to change the style, it is important to not change the CSS directly because any manual modification to the CSS files will be overwritten when compiling the stylus files. Instead, you should make your changes directly in the stylus files and regenerate the CSS.

For this to work, you first need Node and NPM installed on your machine. Then run the following inside of the mdBook directory:

npm install

When that finished, you can simply regenerate the CSS files by building mdBook with the following command:

cargo build --features=regenerate-css

This should automatically call the appropriate stylus command to recompile the files to CSS and include them in the project.

Making a pull-request

When you feel comfortable that your changes could be integrated into mdBook, you can create a pull-request on GitHub. One of the core maintainers will then approve the changes or request some changes before it gets merged.

If you want to make your pull-request even better, you might want to run Clippy and rustfmt on the code first. This is not a requirement though and will never block a pull-request from being merged.

That's it, happy contributions! 🎉 🎉 🎉