Welcome to the Iflytek Opensource Community contributing guide. We are excited about the prospect of you joining our community!
We have full documentation on how to get started contributing:
- Community Governance - How the community is organized
- Community Membership - Membership levels and responsibilities
- Code of Conduct - Our community values and expectations
- Find something to work on - Check open issues, attend SIG meetings, or join discussions on our communication channels
- Read the contributor guide - Understand our processes and conventions
- File an issue - Before starting significant work, discuss your plans (see Issue Guidelines)
- Submit a pull request - Follow our PR workflow
These documents provide detailed guidance on how to contribute effectively:
The Issue Guidelines document covers:
- How to search for existing issues before opening a new one
- What information to include when opening an issue
- The issue triage process and how maintainers review incoming issues
- Issue lifecycle from open to resolved
- Label conventions (
kind/,priority/,sig/,triage/)
The Pull Request Guidelines document covers:
- The pull request process from creation to merge
- How to mark unfinished pull requests (WIP)
- Why pull requests get closed (inactivity after 90 days)
- Why your pull request might not be getting reviewed
- Best practices: smaller PRs, good comments, testing, commit messages
The Review Guidelines document covers tips for reviewers:
- Managing your time for reviews
- When to loop in others with domain-specific knowledge
- How to ask questions and request changes respectfully
- Commit hygiene expectations
- How to check out a pull request locally for deeper review
The Discussions Guidelines document covers:
- What discussions are for (questions, brainstorming, showcase, announcements)
- Discussion categories and when to use each
- Discussion etiquette
- When to use issues vs discussions
We welcome volunteers for our mentorship programs. If you're interested in mentoring or being mentored, please reach out to the community.
Each SIG may have its own policies for editing their section of this repository. Edits in SIG sub-directories should follow any additional guidelines described by the respective SIG leads in the sub-directory's CONTRIBUTING file.
Attending a SIG meeting or posting on their communication channel is recommended if you want to make extensive contributions.