Contribution Guide

Developers are welcome to experience and contribute to this project. Before contributing to the community, please refer to the cann-community to understand the code of conduct, sign the CLA, and learn about the contribution process of the source code repository.

Developers need to pay special attention to the following points when preparing local code and submitting PRs:

When submitting a PR, fill in the business background, purpose, and solution of the PR carefully based on the PR template.
If your modification is not a simple bug fix, but involves adding new features, new interfaces, new configuration parameters or modifying code processes, please be sure to first discuss the solution through an Issue to avoid your code being rejected for merging. If you are not sure whether the modification can be classified as a simple bug fix, you can submit an issue for discussion.

Developer contribution scenarios include:

Fixing Bugs

If you find some bugs in this project and want to fix them, you are welcome to create an issue for feedback and tracking.

You can create a Bug-Report issue to describe the bug according to the Submitting an Issue/Handling an Issue Task guide, and then enter "/assign" or "/assign @yourself" in the comment box to assign the Issue to yourself for handling.
Contributing New Operator Examples

If you have ideas for generalization enhancement/performance optimization for the reference implementation of a certain operator during the use of the template library, or have implemented a certain type of new operator and want to contribute it as a reference example, you are welcome to contribute example operators.

You can create a Requirement/Suggestion Issue to describe the new sample operator and provide your design solution by following the instructions in Submitting an Issue/Handling an Issue Task. Enter /assign or /assign @yourself in the comment box to assign the issue to you for processing.

Place the new operator sample in the ${id}_${op_name} subdirectory under the examples/ directory. ${id} indicates the unique ascending sequence, and ${op_name} indicates the name of the new operator.
```
catlass/examples # Main directory of operator samples
├── ${id}_${op_name} # Single-operator sample directory
│ ├── CMakeLists.txt # CMake build file
│ ├── README.md # Single-operator sample description document
│ └── ${op_name}.cpp # Main file
...
```
The README.md file provides a brief description of the operator, including code organization and usage examples (for details, see the README file of Matmul).
Contributing Template Library Code

If you have new feature implementations for a certain part of the template library code, you are welcome to propose new ideas and designs in an Issue.

You can create a Requirement|Suggestion Issue to describe the new feature design by following the instructions in Submitting an Issue/Handling an Issue Task an Issue/Handling an Issue Task. Project members will communicate with you to confirm the design and provide a suitable location under include/catlass/ for you to contribute your feature code.

In addition, you need to comment /assign or /assign @yourself in the submitted Issue to claim the Issue and complete the code upload in the future.
Reporting Document Error

If you find any errors or unclear descriptions in the documents of this project, you are welcome to create an Issue for feedback and correction.

You can create a Documentation|Document Feedback Issue to point out the problem in the corresponding document by following the instructions in Submitting an Issue/Handling an Issue Task. Then, enter /assign or /assign @yourself in the comment box to assign the Issue to yourself for correcting the document description.
Helping Resolve Others' Issues

If you have a suitable solution to a problem encountered by others in the community, you are welcome to comment and communicate in the Issue to help others solve problems and pain points, and jointly optimize ease of use.

If the corresponding Issue requires code modification, you can enter /assign or /assign @yourself in the Issue comment box to assign the Issue to yourself and track it to assist in solving the problem.