Skip to content

Commit 7b86859

Browse files
Revise contributions guidelines and project overview
1 parent 02d12c1 commit 7b86859

1 file changed

Lines changed: 25 additions & 85 deletions

File tree

CONTRIBUTIONS.md

Lines changed: 25 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -1,107 +1,47 @@
1-
# Learn Rust Programming
1+
# Contributing to Learn Rust Programming
22

3-
An open-source repository to learn **Rust programming from beginner to advanced** through clear examples and small projects.
3+
Thank you for wanting to contribute!
44

5-
The goal of this project is to create a **simple, practical learning path for Rust** without heavy theory — just clear explanations and code.
5+
This repository is designed to help people learn Rust easily.
66

77
---
88

9-
# What You Will Learn
9+
# Ways You Can Contribute
1010

11-
This repository will cover:
12-
13-
* Rust Basics
14-
* Variables and Data Types
15-
* Functions
16-
* Ownership and Borrowing
17-
* Structs and Enums
18-
* Error Handling
19-
* Collections
20-
* Concurrency
21-
* Async Rust
22-
* Systems Programming
23-
* Web Development with Rust
24-
* WebAssembly
25-
* Embedded Rust
26-
27-
---
28-
29-
# Repository Structure
30-
31-
examples/
32-
33-
01_variables.rs
34-
02_functions.rs
35-
03_ownership_and_borrowing.rs
36-
04_structs_enums.rs
37-
05_error_handling.rs
38-
39-
Each file contains **well-commented Rust code explaining a concept**.
40-
41-
---
42-
43-
# How to Run the Examples
44-
45-
Install Rust first:
46-
47-
```
48-
https://rustup.rs
49-
```
50-
51-
Clone the repository:
52-
53-
```
54-
git clone https://github.com/hitesh-bhatnagar/Learn-Rust-Programming
55-
cd Learn-Rust-Programming
56-
```
57-
58-
Run an example:
11+
You can help by:
5912

60-
```
61-
cargo run --example 01_variables
62-
```
13+
* Adding new Rust examples
14+
* Improving comments and explanations
15+
* Fixing bugs in examples
16+
* Adding small Rust projects
17+
* Improving documentation
6318

6419
---
6520

66-
# Who Is This For?
67-
68-
This repository is helpful for:
21+
# How to Contribute
6922

70-
* beginners learning Rust
71-
* programmers switching to Rust
72-
* systems programmers
73-
* backend developers
74-
* embedded developers
23+
1. Fork the repository
24+
2. Clone your fork
25+
3. Create a new branch
26+
4. Add your changes
27+
5. Submit a Pull Request
7528

7629
---
7730

78-
# Contributing
31+
# Code Style
7932

80-
Contributions are welcome!
81-
82-
You can help by:
83-
84-
* adding new Rust examples
85-
* improving explanations
86-
* fixing bugs
87-
* adding mini projects
88-
89-
Please read **CONTRIBUTING.md** before submitting a pull request.
33+
* Keep code simple and beginner friendly
34+
* Add comments explaining the logic
35+
* Make examples easy to understand
9036

9137
---
9238

93-
# Future Topics
39+
# Pull Request Guidelines
9440

95-
Planned additions:
96-
97-
* Rust CLI projects
98-
* Rust networking examples
99-
* Rust web development
100-
* Rust for embedded systems
101-
* Rust for WebAssembly
41+
* Describe what you changed
42+
* Mention the topic you improved
43+
* Keep pull requests small and focused
10244

10345
---
10446

105-
# License
106-
107-
This project will be licensed under the MIT License.
47+
Thank you for helping make Rust learning easier!

0 commit comments

Comments
 (0)