Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Support Request
url: https://github.com/iflytek/community/discussions
about: Support request or question relating to the Iflytek Opensource Community
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/general-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: General Issue
description: Open a general issue in the iflytek/community repo
body:
- id: problem
type: textarea
attributes:
label: Describe the issue
placeholder: A clear and concise description of what you need assistance with.
validations:
required: true
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/leadership-change.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Leadership Change
description: Onboarding / Offboarding checklist for group leads
title: "<Group FOO>: Leadership Change"
body:
- id: group
type: input
attributes:
label: "Group name:"
placeholder: "e.g. SIG foo"
- id: leader_onboarding
type: input
attributes:
label: "Onboarding Lead(s):"
placeholder: GitHub handle(s) of the new leads
- id: leader_offboarding
type: input
attributes:
label: "Offboarding Lead(s):"
placeholder: GitHub handle(s) of the previous leads
- type: markdown
attributes:
value: |
**Process to initiate leadership change**

An email should be sent to the group mailing list with the following:
- Intent to step down / nominate a new lead
- If nominating a new lead:
- 1-2 lines about why they are being nominated, and links to any potential meeting notes where the change was discussed.
- Contacts to privately reach out to for questions (current leads) or concerns.
- Lazy consensus deadline of at least one week.
- id: discussion_link
type: input
attributes:
label: "Link to discussion:"
- id: new_lead_prereqs
type: checkboxes
attributes:
label: "Prerequisites for new leads:"
options:
- label: Are an org member
- label: Have read and agree to abide by the [Code of Conduct](https://github.com/iflytek/community/blob/main/code-of-conduct.md)
- id: req_checklist
type: checkboxes
attributes:
label: "Onboarding / Offboarding tasks:"
options:
- label: Updated [OWNERS](https://github.com/iflytek/community/blob/main/OWNERS) file. **NOTE:** If offboarding, remember to remove from approvers.
- label: Updated [MAINTAINERS.md](https://github.com/iflytek/community/blob/main/MAINTAINERS.md).
- label: Updated access/teams in project infrastructure.
- label: Updated ownership of group mailing list.
- label: Updated ownership of group calendar.
- label: Added to relevant communication channels.
- id: additional_info
type: textarea
attributes:
label: "Additional information:"
placeholder: "Other links to leadership discussions etc."
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/moderator_application.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Community Moderator Request
description: Request moderator privileges on a community property
title: 'REQUEST: New moderator for <your-GH-handle> of <community property>'
labels: area/community-management
body:
- id: github
type: input
attributes:
label: GitHub Username
placeholder: e.g. @example_user
validations:
required: true
- type: input
attributes:
label: Property you'd like to Moderate
placeholder: e.g. Discord, forum, etc.
validations:
required: true
- type: input
attributes:
label: Username on Property Requested
placeholder: e.g. @property_user
validations:
required: true
- id: requirements
type: checkboxes
attributes:
label: Requirements
options:
- label: I am an org member already
required: true
- label: I have [enabled 2FA on my GitHub account](https://github.com/settings/security)
required: true
- label: I have read and will abide by the policies mentioned in the [Moderation Guidelines](https://github.com/iflytek/community/blob/main/code-of-conduct.md)
required: true
- label: I have two sponsors that meet the sponsor requirements
required: true
- label: I have spoken to my sponsors ahead of this application, and they have agreed to sponsor my application
required: true
- id: sponsor_1
type: input
attributes:
label: "Sponsor 1"
description: GitHub handle of your sponsor
placeholder: e.g. @sponsor-1
validations:
required: true
- id: sponsor_2
type: input
attributes:
label: "Sponsor 2"
description: GitHub handle of your sponsor
placeholder: e.g. @sponsor-2
validations:
required: true
- id: qualifications
type: textarea
attributes:
label: List of qualifications for this position
placeholder: |
- Prior moderation experience
- Links to public discussions showing your moderation experience (if available)
- Any other qualifications
validations:
required: true
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- Thanks for sending a pull request! Here are some tips for you:

- If this is your first contribution, read our Getting Started guide https://github.com/iflytek/community/blob/main/CONTRIBUTING.md

-->

**Which issue(s) this PR fixes**:
<!--
*Automatically closes linked issue when PR is merged.
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
_If PR is about `failing-tests or flakes`, please post the related issues/tests in a comment and do not use `Fixes`_*
-->
Fixes #

**Special notes for reviewers**:
<!--
Please leave this section blank if you don't have any special notes.
-->
83 changes: 83 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Contributing to the Community

<!-- toc -->
- [Getting Started](#getting-started)
- [How to Contribute](#how-to-contribute)
- [Contributor Guides](#contributor-guides)
- [Issue Guidelines](#issue-guidelines)
- [Pull Request Guidelines](#pull-request-guidelines)
- [Review Guidelines](#review-guidelines)
- [Discussions Guidelines](#discussions-guidelines)
- [Mentorship](#mentorship)
- [Contributing to Individual SIGs](#contributing-to-individual-sigs)
<!-- /toc -->

Welcome to the Iflytek Opensource Community contributing guide. We are excited about the prospect of you joining our community!

## Getting Started

We have full documentation on how to get started contributing:

* [Community Governance](governance.md) - How the community is organized
* [Community Membership](community-membership.md) - Membership levels and responsibilities
* [Code of Conduct](code-of-conduct.md) - Our community values and expectations

## How to Contribute

1. **Find something to work on** - Check [open issues](https://github.com/iflytek/community/issues), attend SIG meetings, or join discussions on our communication channels
2. **Read the contributor guide** - Understand our processes and conventions
3. **File an issue** - Before starting significant work, discuss your plans (see [Issue Guidelines](contribute/issue-guidelines.md))
4. **Submit a pull request** - Follow our [PR workflow](contribute/pull-request-guidelines.md)

## Contributor Guides

These documents provide detailed guidance on how to contribute effectively:

### Issue Guidelines

The [Issue Guidelines](contribute/issue-guidelines.md) 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/`)

### Pull Request Guidelines

The [Pull Request Guidelines](contribute/pull-request-guidelines.md) 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

### Review Guidelines

The [Review Guidelines](contribute/review-guidelines.md) 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

### Discussions Guidelines

The [Discussions Guidelines](contribute/discussions-guidelines.md) 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

## Mentorship

We welcome volunteers for our mentorship programs. If you're interested in mentoring or being mentored, please reach out to the community.

## Contributing to Individual SIGs

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.
44 changes: 44 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Security Policy

<!-- toc -->
- [Reporting a Vulnerability](#reporting-a-vulnerability)
- [What to Include](#what-to-include)
- [What to Expect](#what-to-expect)
- [Supported Versions](#supported-versions)
- [Security Best Practices](#security-best-practices)
<!-- /toc -->

If you discover a security issue in this project, please follow the guidelines below.

## Reporting a Vulnerability

**Do not** report security vulnerabilities through public GitHub issues.

Instead, please report security vulnerabilities by emailing the project's security team. The team will investigate and respond as soon as possible.

### What to Include

Please include the following information in your report:

* A description of the vulnerability
* Steps to reproduce the issue
* Potential impact of the vulnerability
* Any suggested fixes or mitigations (if available)

### What to Expect

* **Acknowledgment**: We will acknowledge receipt of your report within 48 hours
* **Assessment**: We will assess the vulnerability and determine the severity
* **Resolution**: We will work on a fix and coordinate the disclosure
* **Credit**: We will credit you for the discovery (unless you prefer to remain anonymous)

## Supported Versions

Only the latest release receives security patches. Users are encouraged to upgrade to the latest version to receive security fixes.

## Security Best Practices

* Keep all dependencies up to date
* Enable two-factor authentication on your GitHub account
* Follow the principle of least privilege when granting access
* Review code changes carefully before merging
Loading
Loading