Skip to content

Commit 044c95f

Browse files
ysyneuysyneu
committed
chore: add open-source community health files
Bring the repo up to standard OSS project layout (mirroring flashduty-mcp-server): contributing guide, code of conduct (Contributor Covenant 2.1 by reference), security policy, support doc, issue/PR templates, CODEOWNERS, and Dependabot config. README/README_zh gain Contributing/Security sections plus release, CI, and Go Report Card badges.
1 parent 679e692 commit 044c95f

11 files changed

Lines changed: 202 additions & 0 deletions

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @flashcatcloud/flashduty-cli

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: "\U0001F41B Bug report"
3+
about: Report a bug or unexpected behavior while using Flashduty CLI
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
### Describe the bug
11+
12+
A clear and concise description of what the bug is.
13+
14+
### Affected version
15+
16+
Please run `flashduty version` and paste the output below.
17+
18+
### Steps to reproduce the behavior
19+
20+
1. Run this command '...'
21+
2. View the output '....'
22+
3. See error
23+
24+
### Expected vs actual behavior
25+
26+
A clear and concise description of what you expected to happen and what actually happened.
27+
28+
### Logs
29+
30+
Paste any available logs or command output. Redact app keys and other secrets if needed.
31+
32+
Closes:

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: "⭐ Submit a feature request"
3+
about: Surface a feature or problem that you think should be solved
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
### Describe the feature or problem you'd like to solve
11+
12+
A clear and concise description of what the feature or problem is.
13+
14+
### Proposed solution
15+
16+
How will it benefit Flashduty CLI and its users?
17+
18+
### Example commands or workflows
19+
20+
If it's a new command or improvement, share 3–5 example invocations or workflows it would enable. Just enough detail to show the value.
21+
22+
### Additional context
23+
24+
Add any other context, screenshots, or mockups here, if applicable.

‎.github/dependabot.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "gomod"
9+
directory: "/"
10+
schedule:
11+
interval: "weekly"
12+
- package-ecosystem: "github-actions"
13+
directory: "/"
14+
schedule:
15+
interval: "weekly"

‎.github/pull_request_template.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!--
2+
Thank you for contributing to Flashduty CLI!
3+
Please reference an existing issue: `Closes #NUMBER`
4+
5+
Consider addressing the following:
6+
- Tradeoffs: List tradeoffs you made to take on or pay down tech debt.
7+
- Alternatives: Describe alternative approaches you considered and why you discarded them.
8+
-->
9+
10+
Closes:

‎CODE_OF_CONDUCT.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Code of Conduct
2+
3+
This project has adopted the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1, as its Code of Conduct. Contributors and participants are expected to uphold it.
4+
5+
The full text is available at:
6+
7+
- English: https://www.contributor-covenant.org/version/2/1/code_of_conduct/
8+
- 中文: https://www.contributor-covenant.org/zh-cn/version/2/1/code_of_conduct/
9+
10+
## Enforcement
11+
12+
Instances of abusive or otherwise unacceptable behavior may be reported to the project maintainers at [support@flashcat.cloud](mailto:support@flashcat.cloud). All complaints will be reviewed and investigated promptly and fairly. Maintainers are obligated to respect the privacy and security of the reporter of any incident.

‎CONTRIBUTING.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing
2+
3+
Hi there! We're thrilled that you'd like to contribute to Flashduty CLI. Your help is essential for keeping it great.
4+
5+
Contributions to this project are [released](https://docs.github.com/site-policy/github-terms/github-terms-of-service#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).
6+
7+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
8+
9+
## Prerequisites for running and testing code
10+
11+
These are one-time installations required to test your changes locally as part of the pull request (PR) submission process.
12+
13+
1. Install Go — [download](https://go.dev/doc/install) or [via Homebrew](https://formulae.brew.sh/formula/go). See `go.mod` for the minimum required version.
14+
2. [Install golangci-lint v2](https://golangci-lint.run/welcome/install/).
15+
16+
## Submitting a pull request
17+
18+
1. [Fork](https://github.com/flashcatcloud/flashduty-cli/fork) and clone the repository.
19+
2. Make sure the tests pass on your machine: `go test ./...`
20+
3. Make sure the linter passes on your machine: `golangci-lint run`
21+
4. Create a new branch: `git checkout -b my-branch-name`
22+
5. Make your change, add tests, and make sure the tests and linter still pass.
23+
6. Push to your fork and [submit a pull request](https://github.com/flashcatcloud/flashduty-cli/compare) targeting the `main` branch.
24+
7. Pat yourself on the back and wait for your pull request to be reviewed and merged.
25+
26+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
27+
28+
- Write tests.
29+
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
30+
- Write a [good commit message](https://cbea.ms/git-commit/).
31+
32+
## Resources
33+
34+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
35+
- [Using Pull Requests](https://docs.github.com/pull-requests)
36+
- [GitHub Help](https://docs.github.com)

‎README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
English | [中文](README_zh.md)
44

55
[![License](https://img.shields.io/github/license/flashcatcloud/flashduty-cli?style=flat-square&color=24bfa5&label=License)](LICENSE)
6+
[![Release](https://img.shields.io/github/v/release/flashcatcloud/flashduty-cli?style=flat-square&color=24bfa5)](https://github.com/flashcatcloud/flashduty-cli/releases)
7+
[![CI](https://img.shields.io/github/actions/workflow/status/flashcatcloud/flashduty-cli/ci.yml?style=flat-square&branch=main&label=CI)](https://github.com/flashcatcloud/flashduty-cli/actions)
8+
[![Go Report Card](https://goreportcard.com/badge/github.com/flashcatcloud/flashduty-cli?style=flat-square)](https://goreportcard.com/report/github.com/flashcatcloud/flashduty-cli)
69

710
A command-line interface for the [Flashduty](https://flashcat.cloud) platform. Manage incidents, on-call schedules, status pages, and more from your terminal.
811

@@ -307,6 +310,16 @@ make help # Show all available targets
307310

308311
---
309312

313+
## Contributing
314+
315+
Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request, and note our [Code of Conduct](CODE_OF_CONDUCT.md).
316+
317+
- [Report a bug or request a feature](https://github.com/flashcatcloud/flashduty-cli/issues/new/choose)
318+
- [Get help and support](SUPPORT.md)
319+
- [Report a security vulnerability](SECURITY.md)
320+
321+
---
322+
310323
## License
311324

312325
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

‎README_zh.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
[English](README.md) | 中文
44

55
[![License](https://img.shields.io/github/license/flashcatcloud/flashduty-cli?style=flat-square&color=24bfa5&label=License)](LICENSE)
6+
[![Release](https://img.shields.io/github/v/release/flashcatcloud/flashduty-cli?style=flat-square&color=24bfa5)](https://github.com/flashcatcloud/flashduty-cli/releases)
7+
[![CI](https://img.shields.io/github/actions/workflow/status/flashcatcloud/flashduty-cli/ci.yml?style=flat-square&branch=main&label=CI)](https://github.com/flashcatcloud/flashduty-cli/actions)
8+
[![Go Report Card](https://goreportcard.com/badge/github.com/flashcatcloud/flashduty-cli?style=flat-square)](https://goreportcard.com/report/github.com/flashcatcloud/flashduty-cli)
69

710
[Flashduty](https://flashcat.cloud) 平台的命令行工具。在终端中管理故障、值班、状态页等。
811

@@ -288,6 +291,16 @@ make help # 显示所有可用目标
288291

289292
---
290293

294+
## 参与贡献
295+
296+
欢迎贡献代码！提交 Pull Request 前请阅读 [CONTRIBUTING.md](CONTRIBUTING.md)，并遵守我们的[行为准则](CODE_OF_CONDUCT.md)。
297+
298+
- [报告缺陷或提交需求](https://github.com/flashcatcloud/flashduty-cli/issues/new/choose)
299+
- [获取帮助与支持](SUPPORT.md)
300+
- [报告安全漏洞](SECURITY.md)
301+
302+
---
303+
291304
## 许可证
292305

293306
本项目基于 MIT 许可证开源 - 详见 [LICENSE](LICENSE) 文件。

‎SECURITY.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Thanks for helping make Flashduty safe for everyone.
2+
3+
# Security
4+
5+
Flashduty takes the security of our software products and services seriously, including all of the open source code repositories managed through our organizations, such as [Flashcat](https://github.com/flashcatcloud).
6+
7+
Even though open source repositories are outside of the scope of our bug bounty program and therefore not eligible for bounty rewards, we will ensure that your finding gets passed along to the appropriate maintainers for remediation.
8+
9+
## Reporting Security Issues
10+
11+
If you believe you have found a security vulnerability in any Flashduty-owned repository, please report it to us through coordinated disclosure.
12+
13+
**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**
14+
15+
Instead, please send an email to [support@flashcat.cloud](mailto:support@flashcat.cloud).
16+
17+
Please include as much of the information listed below as you can to help us better understand and resolve the issue:
18+
19+
* The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
20+
* Full paths of source file(s) related to the manifestation of the issue
21+
* The location of the affected source code (tag/branch/commit or direct URL)
22+
* Any special configuration required to reproduce the issue
23+
* Step-by-step instructions to reproduce the issue
24+
* Proof-of-concept or exploit code (if possible)
25+
* Impact of the issue, including how an attacker might exploit the issue
26+
27+
This information will help us triage your report more quickly.
28+
29+
## Policy
30+
31+
Flashduty is committed to responsible security vulnerability disclosure. We pledge to work with security researchers to resolve reported vulnerabilities in a timely manner and to publicly acknowledge their contributions when appropriate.
32+
33+
We will not take legal action against researchers who report security vulnerabilities in good faith, provided they follow our disclosure guidelines.

0 commit comments

Comments
 (0)