• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Contributing Guidelines
2
3## Contribute
4
5We welcome contributions from the community! By contributing, you can help improve FFRT and make it more robust.
6
7Here are some ways you can contribute:
8
91. Report Issues:
10
11    - If you encounter any bugs or have suggestions for improvements, please open an issue on this repository. Provide detailed information to help us understand and resolve the issue.
12
132. Submit Pull Requests:
14
15    - If you have made improvements to the code, feel free to submit a pull request. Ensure that your code adheres to the projects's coding standards and is well-documented.
16    - Please ensure that your code follows the project's coding standards. We use `.clang-format` to maintain consistent code style. Run the following command to format your code before committing:
17
18        ```shell
19        clang-format -i file
20        ```
21
22    - To ensure documentation quality, we use:
23
24        - `cspell.json` for spell checking. Run the following command to check for spelling errors:
25
26            ```shell
27            cspell "src/**/*.cpp" "docs/**/*.md"
28            ```
29
30        - `.markdownlint.json` for Markdown file format standards. Run the following commands to lint your Markdown files:
31
32            ```shell
33            markdownlint "**/*.md"
34            ```
35
36        - `.autocorrectrc` and `.autocorrectignore` for ensuring proper formatting of mixed Chinese and English content. Run the following commands to autocorrect documentation:
37
38            ```shell
39            autocorrect "**/*.md"
40            ```
41
42    - We also recommend using the following VSCode plugins to help adhere to coding and documentation standards:
43
44        - [Clang-Format](https://marketplace.visualstudio.com/items?itemName=xaver.clang-format) or [C/C++](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) for maintaining consistent code style.
45        - [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) for spell checking
46        - [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) for Markdown file format linting.
47        - [AutoCorrect](https://marketplace.visualstudio.com/items?itemName=huacnlee.autocorrect) for auto-correcting mixed Chinese and English content.
48
493. Write Tests:
50
51    - To maintain the quality of the project, we encourage you to write tests for new features and bug fixes. This helps ensure that the codebase remains stable and reliable.
52
534. Improve Documentation:
54
55    - Good documentation is key to a successful project. If you find areas in the documentation that can be improved, please contribute by updating the `README.md` or other documentation files.
56
575. Review Pull Requests:
58
59    - Reviewing and providing feedback on other contributor's pull requests is a valuable way to contribute. Your insights can help maintain the quality and consistency of the project.
60
61## Code of Conduct
62
63By participating in this project, you agree to abide by our [Code of Conduct](https://developer.huawei.com/consumer/en/devservice/guidelines/). Please read it to understand the standards and expectations for contributing.
64
65## Get in Touch
66
67If you have any questions or need further guidance, feel free to reach us via [email](mailto:hiffrt@huawei.com) or join our [Q&A community](https://developer.huawei.com/consumer/cn/forum/).
68
69Thank you for your contributions and support!
70