Thank you for your interest in the Codefuse project. We warmly welcome any suggestions, opinions (including criticisms), comments, and contributions to the Codefuse project.
Your suggestions, opinions, and comments on Codefuse can be directly submitted through GitHub Issues.
There are many ways to participate in the Codefuse project and contribute to it: code implementation, test writing, process tool improvement, documentation enhancement, and more. We welcome any contributions and will add you to our list of contributors.
Furthermore, with enough contributions, you may have the opportunity to become a Committer for Codefuse.
For any questions, you can contact us for timely answers through various means including WeChat, Gitter (an instant messaging tool provided by GitHub), email, and more.
If you are new to the Codefuse community, you can:
Through the above methods, you can stay up-to-date with the development dynamics of the Codefuse project and express your opinions on topics of interest.
This contribution guide is not just about writing code. We value and appreciate help in all areas. Here are some ways you can contribute:
Documentation is the main way for you to understand Codefuse and is also where we need the most help!
By browsing the documentation, you can deepen your understanding of Codefuse and also help you grasp the features and technical details of Codefuse. If you find any issues with the documentation, please contact us in time;
If you are interested in improving the quality of the documentation, whether it is revising an address of a page, correcting a link, or writing a better introductory document, we are very welcoming!
Most of our documentation is written in markdown format. You can directly modify and submit documentation changes in the docs/ directory on GitHub. For submitting code changes, please refer to Pull Requests.
If you discover a bug or issue, you can directly submit a new Issue through GitHub Issues, and someone will handle it regularly. For more details, see Issue Template.Issue Template
You can also choose to read and analyze the code to fix it yourself (it is best to communicate with us before doing so, as someone might already be working on the same issue), and then submit a Pull Request.
You can download the code, compile, install, and deploy to try it out (you can refer to the compilation documentation to see if it works as you expected). If there are any issues, you can directly contact us, submit an Issue, or fix it yourself by reading and analyzing the source code. For more details, seeContribution
Whether it's fixing a bug or adding a feature, we warmly welcome it. If you wish to submit code to Doris, you need to fork the code repository to your project space on GitHub, create a new branch for your submitted code, add the original project as an upstream, and submit a PR. The method for submitting a PR can be referenced in the Pull Request documentation.
Issues can be categorized into three types:
Checklist before submitting an issue
Please confirm that you have checked the document, issues, discussions (GitHub feature), and other publicly available documentation.
System Information
Please confirm your operating system, such as mac-xx, windows-xx, linux-xx.
Code Version
Please confirm the code version or branch, such as master, release, etc.
Problem Description
Describe the problem you encountered, what you want to achieve, or the bug encountered during code execution.
Code Example
Attach your execution code and relevant configuration to facilitate rapid intervention and reproduction.
Error Information, Logs
The error logs and related information after executing the above code example.
Related Dependencies
Taking the chatbot project as an example:
Issue with current documentation:
Please point out any problems, typos, or confusing points in the current documentation.
Idea or request for content
What do you think would be a reasonable way to express the documentation?
Checklist before submitting an issue
Please confirm that you have checked the document, issues, discussions (GitHub feature), and other publicly available documentation.
Feature Description
Describe the purpose of this feature.
Related Examples
Provide references to documents, repositories, etc., Please provide links to any relevant GitHub repos, papers, or other resources if relevant.
Motivation
Describe the motivation for this feature. Why is it needed? Provide enough context information to help understand the demand for this feature.
Contribution
How you can contribute to the building of this feature (if you are participating).
A description of the PR should be articulated in concise language, highlighting the work completed by the PR. See specific standards atCommit Format Specification
#xx if has
Please provide relevant test code when necessary.
A commit consists of a "title" and a "body." The title should generally be in lowercase, while the first letter of the body should be uppercase.
The title of the commit message: [<type>](<scope>) <subject> (#pr)
本次提交的类型,限定在以下类型(全小写)
Please note:
If multiple types occur in one commit, add multiple types.
If code refactoring leads to performance improvement, both [refactor][optimize] can be added.
Other types not listed above should not appear. If necessary, new types must be added to this document.
The scope of the modules involved in the current submission. Due to the multitude of functional modules, only a few are listed here, and this list will be updated continuously based on needs.
For example, using a chatbot framework: connector codechat sandbox ...
Please note:
Try to use options that are already listed. If you need to add new ones, please update this document promptly.
The title should clearly indicate the main content of the current submission.
comming soon
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。