Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

43 lines (26 loc) · 1.06 KB

Contribution Guide

I, melikechan would be delighted to see your contributions to this repository. This guideline is incomplete, please feel free to ask questions or suggest changes.

Fixing false information

If you find any false information in the examples, please open an issue and elaborate on the false information. If you can provide a fix, please open a pull request.

Adding new examples

If you want to add a new example, please follow the steps below:

  1. Create a new folder for the example in the appropriate category.
  2. Add the example to the folder.
  3. Create a README.md file in the folder to explain the example.

README.md template

# Topic name

Description of the topic.

## How to run

1. Step 1
2. Step 2
3. Step 3

## How it works

Explanation of how the example works. (e.g., functions, algorithms)

### Functions

- `function1()`: Description of the function.
- `function2()`: Description of the function.

## Links

- [Link 1](https://example.com)
- [Link 2](https://example.com)