Mirrors/idiomatic-rust
2
0
Fork 0
mirror of https://github.com/mre/idiomatic-rust synced 2024-11-21 19:43:04 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update CONTRIBUTING.md

Browse source
This commit is contained in:
Matthias Endler 2024-02-01 01:40:08 +01:00 committed by GitHub
parent c91363739e
commit 9e3b6d178f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 70 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

84
CONTRIBUTING.md
View file

@ -1,21 +1,77 @@
**Thanks for helping out!** :tada:
# Contributing to Idiomatic Rust
Please feel free to open a pull request if you know of a good article/talk/rescource about idiomatic Rust,
that is not mentioned here.
## Introduction
How to add new articles:
Thank you for your interest in contributing to Idiomatic Rust! This guide will
help you understand how to contribute effectively.
1. Pick a promising article from [This Week in Rust](https://this-week-in-rust.org/) or the top weekly articles from [/r/rustlang](https://www.reddit.com/r/rust/top/?t=week).
2. Read the article.
3. Decide if it contains useful rescources about idiomatic Rustlang code.
4. Create a pull request with the article.
## `README` is Auto-Generated
How to add new talks/videos:
Please note that the `README.md` file in this repository is auto-generated
*using a
Rust script. **Do not edit the `README.md` file directly.** Instead, make
changes to the `resources.json` file or the Rust script.
1. Pick a promising video from the [Rustlang YouTube channel](https://www.youtube.com/channel/UCaYhcUwRBNscFNUKTjgPFiA).
2. Watch the video.
3. Decide if it contains useful rescources about idiomatic Rustlang code.
4. Create a pull request with the talk/video.
### Generating the README
To generate the README, ensure that Rust is installed on your machine. You can
then run the following command:
If you're unsure, just create a pull request or create a new issue and we can decide together.
```sh
make render
```
This will update the `README.md` file based on the current contents of
`resources.json`.
### Adding Resources to `resources.json`
`resources.json` is the primary file where resources about idiomatic Rust are
listed. The file is structured in a JSON array, where each resource is an object
with specific fields.
### File Structure
Each resource object in `resources.json` should have the following structure:
```json
{
"title": "Resource Title",
"url": "https://resource.url",
"description": "A brief description of the resource.",
"tags": ["tag1", "tag2"],
"official": true or false,
"year": YearOfPublication,
"difficultyLevel": "beginner | intermediate | advanced",
"duration": "time duration (if audio/video) or null",
"interactivityLevel": "low | medium | high",
"free": true or false,
"category": "project | workshop | book | article | talk | forum"
}
```
Check out the file for some examples.
Please ensure that your addition adheres to this format for consistency.
### Adding a New Resource
1. Fork the repository.
2. Add your resource to `resources.json`, following the structure above.
3. Run `make render` to locally to generate the README.
4. Create a pull request with your changes.
### Pull Requests
When you submit a pull request, please include the following:
* A brief explanation of the resource and why it's beneficial for idiomatic
Rust.
* Confirmation that the resource links and information are current and valid.
### Questions or Issues
If you have any questions or encounter any issues, please open an issue in the
repository, and we'll get back to you as soon as possible.
Thank you for contributing to making Rust programming more idiomatic and
accessible!