Skip to content

Commit 3e567ad

Browse files
authored
added contribution
1 parent 62000ee commit 3e567ad

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

CONTRIBUTING.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
Certainly! Let's create a Markdown contribution guide for the **Modular-Rust-Learning** project. Below is a structured document you can use:
2+
3+
---
4+
5+
# Contributing to Modular-Rust-Learning
6+
7+
Welcome to the Modular-Rust-Learning project! We appreciate your interest in contributing. Whether you're a seasoned Rust developer or just getting started, there are several ways you can contribute to this project.
8+
9+
## Table of Contents
10+
11+
1. [Getting Started](#getting-started)
12+
2. [Contributing Guidelines](#contributing-guidelines)
13+
3. [Code of Conduct](#code-of-conduct)
14+
4. [Reporting Issues](#reporting-issues)
15+
5. [Submitting Pull Requests](#submitting-pull-requests)
16+
6. [Project Structure](#project-structure)
17+
7. [Additional Resources](#additional-resources)
18+
19+
## Getting Started
20+
21+
Before you start contributing, make sure you have the following prerequisites:
22+
23+
- Rust installed (version X.Y.Z or later)
24+
- Git installed
25+
- A GitHub account
26+
27+
## Contributing Guidelines
28+
29+
Please follow these guidelines when contributing:
30+
31+
1. Fork the repository to your GitHub account.
32+
2. Clone your forked repository to your local machine.
33+
3. Create a new branch for your contribution (e.g., `feature/my-awesome-contribution`).
34+
4. Make your changes (code, documentation, etc.).
35+
5. Commit your changes with a descriptive message.
36+
6. Push your changes to your forked repository.
37+
7. Create a pull request (PR) from your branch to the main repository.
38+
39+
## Code of Conduct
40+
41+
We expect all contributors to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). Be respectful, inclusive, and collaborative.
42+
43+
## Reporting Issues
44+
45+
If you encounter any issues or bugs, please [open an issue](https://github.com/mdabir1203/Modular-Rust-Learning/issues) with detailed information.
46+
47+
## Submitting Pull Requests
48+
49+
When submitting a PR:
50+
51+
- Provide a clear description of your changes.
52+
- Follow the existing coding conventions.
53+
- Engage in discussions with maintainers if needed.
54+
55+
## Project Structure
56+
57+
The project is organized into modules, each focusing on a specific topic related to Rust. Explore the codebase and find areas where you can contribute!
58+
59+
## Additional Resources
60+
61+
- [Official Rust Documentation](https://doc.rust-lang.org/)
62+
- [Rust Community Forum](https://users.rust-lang.org/)
63+
64+
Happy coding! 🚀
65+
66+
---
67+
68+
Feel free to customize this template according to the specifics of your project. Good luck with your contributions! 😊🌟

0 commit comments

Comments
 (0)