Skip to content

Commit

Permalink
added contribution
Browse files Browse the repository at this point in the history
  • Loading branch information
mdabir1203 authored Aug 26, 2024
1 parent 62000ee commit 3e567ad
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
Certainly! Let's create a Markdown contribution guide for the **Modular-Rust-Learning** project. Below is a structured document you can use:

---

# Contributing to Modular-Rust-Learning

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.

## Table of Contents

1. [Getting Started](#getting-started)
2. [Contributing Guidelines](#contributing-guidelines)
3. [Code of Conduct](#code-of-conduct)
4. [Reporting Issues](#reporting-issues)
5. [Submitting Pull Requests](#submitting-pull-requests)
6. [Project Structure](#project-structure)
7. [Additional Resources](#additional-resources)

## Getting Started

Before you start contributing, make sure you have the following prerequisites:

- Rust installed (version X.Y.Z or later)
- Git installed
- A GitHub account

## Contributing Guidelines

Please follow these guidelines when contributing:

1. Fork the repository to your GitHub account.
2. Clone your forked repository to your local machine.
3. Create a new branch for your contribution (e.g., `feature/my-awesome-contribution`).
4. Make your changes (code, documentation, etc.).
5. Commit your changes with a descriptive message.
6. Push your changes to your forked repository.
7. Create a pull request (PR) from your branch to the main repository.

## Code of Conduct

We expect all contributors to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). Be respectful, inclusive, and collaborative.

## Reporting Issues

If you encounter any issues or bugs, please [open an issue](https://github.com/mdabir1203/Modular-Rust-Learning/issues) with detailed information.

## Submitting Pull Requests

When submitting a PR:

- Provide a clear description of your changes.
- Follow the existing coding conventions.
- Engage in discussions with maintainers if needed.

## Project Structure

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!

## Additional Resources

- [Official Rust Documentation](https://doc.rust-lang.org/)
- [Rust Community Forum](https://users.rust-lang.org/)

Happy coding! 🚀

---

Feel free to customize this template according to the specifics of your project. Good luck with your contributions! 😊🌟

0 comments on commit 3e567ad

Please sign in to comment.