From 0168a4e293db36d9754780885e23a16b55eed47a Mon Sep 17 00:00:00 2001 From: XN Date: Sun, 12 Jul 2026 01:27:14 +0800 Subject: [PATCH] chore: add open-source readiness docs and templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 62 +++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature_request.yml | 33 +++++++++ .github/pull_request_template.md | 15 ++++ CODE_OF_CONDUCT.md | 80 ++++++++++++++++++++++ CONTRIBUTING.md | 46 +++++++++++++ README.md | 12 +++- SECURITY.md | 21 ++++++ 8 files changed, 272 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/pull_request_template.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 SECURITY.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..507140c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,62 @@ +name: Bug report +description: Report a reproducible problem in FreeDock +title: "bug: " +labels: + - bug +body: + - type: textarea + id: summary + attributes: + label: Summary + description: Clear description of the problem + validations: + required: true + + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + description: Provide exact, numbered steps + placeholder: | + 1. Open FreeDock + 2. Create a new vertical dock + 3. Drag App X into the dock + 4. Observe ... + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected behavior + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual behavior + validations: + required: true + + - type: input + id: macos + attributes: + label: macOS version + placeholder: "macOS 14.5" + validations: + required: true + + - type: input + id: version + attributes: + label: FreeDock version or commit SHA + placeholder: "v0.1.0 or abc1234" + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Logs or screenshots + description: Paste relevant logs or attach screenshots if useful diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..e93068e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Security vulnerability report + url: mailto:horxiangneng123@gmail.com + about: Please report vulnerabilities privately by email. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..8b1d0a0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,33 @@ +name: Feature request +description: Suggest an improvement for FreeDock +title: "feat: " +labels: + - enhancement +body: + - type: textarea + id: problem + attributes: + label: Problem to solve + description: What workflow or pain point are you trying to improve? + validations: + required: true + + - type: textarea + id: proposal + attributes: + label: Proposed solution + description: Describe the behavior you want + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + description: Any workaround or alternative approach you tried + + - type: textarea + id: context + attributes: + label: Additional context + description: Mockups, examples, or related links diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..677326e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,15 @@ +## Summary + +- What changed? +- Why was this change needed? + +## Testing + +- [ ] `swift test` +- [ ] Manual verification done (if relevant) + +## Checklist + +- [ ] Scope is focused and minimal +- [ ] Docs updated (if needed) +- [ ] No secrets or private data added diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..5c053a4 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,80 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +- Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or + advances of any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email + address, without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for +moderation decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at: + +- `horxiangneng123@gmail.com` + +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. + +Community Impact Guidelines were inspired by +https://github.com/mozilla/diversity. + +[homepage]: https://www.contributor-covenant.org diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..38dc29c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,46 @@ +# Contributing to FreeDock + +Thanks for your interest in improving FreeDock. + +## Quick Start + +1. Fork the repository and create a branch from `main`. +2. Build locally: + +```bash +make run +``` + +3. Run tests before opening a PR: + +```bash +swift test +``` + +## Pull Request Guidelines + +- Keep changes focused and small when possible. +- Include a clear title and description of what changed and why. +- Add or update tests when behavior changes. +- Update docs when user-facing behavior or setup changes. + +## Commit Messages + +Use concise, descriptive commit messages. Common prefixes in this repo include: + +- `feat:` for new features +- `fix:` for bug fixes +- `chore:` for maintenance or docs/config updates + +## Reporting Bugs + +Please use the Bug Report issue template and include: + +- macOS version +- FreeDock version or commit SHA +- exact reproduction steps +- expected behavior vs actual behavior + +## Code of Conduct + +By participating, you agree to follow `CODE_OF_CONDUCT.md`. diff --git a/README.md b/README.md index 31555e5..22a9a8d 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ FreeDock lets you create unlimited floating docks on any macOS screen. Pin your ## Installation -Download the latest `FreeDock.app` from the [Releases](https://github.com/Rubyherp/FreeDock/releases) page, then drag it to your Applications folder. +Download the latest `FreeDock.app` from the [Releases](https://github.com/Rubyherp/FreeDock/releases) page (when available), then drag it to your Applications folder. ### Build from source @@ -119,7 +119,15 @@ Docks are saved to `~/.config/freedock.json`. The file is human-readable and edi ## Contributing -Contributions are welcome! Open an issue or submit a PR. +Contributions are welcome! Please read `CONTRIBUTING.md` before opening a PR. + +## Security + +To report a vulnerability, please follow `SECURITY.md` and avoid public issue disclosure. + +## Code of Conduct + +Please read `CODE_OF_CONDUCT.md` before participating. ## License diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..ee846ca --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,21 @@ +# Security Policy + +## Supported Versions + +Security fixes are currently applied to the latest code on `main`. + +## Reporting a Vulnerability + +Please do not open public issues for security vulnerabilities. + +Instead, report privately by email: + +- `horxiangneng123@gmail.com` + +Please include: + +- a clear description of the issue +- reproduction steps or proof of concept +- potential impact + +I will acknowledge reports as soon as possible and coordinate a fix and disclosure timeline.