From 3e376dc67f2f0819a2ee0bcf829d6ddc3b5a6a11 Mon Sep 17 00:00:00 2001 From: Jun Kurihara Date: Sat, 30 Aug 2025 01:56:36 +0900 Subject: [PATCH] add CONTRIBUTING.md --- .github/ISSUE_TEMPLATE/bug_report.md | 50 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature_request.md | 43 +++++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 27 +++++++++++ .github/ISSUE_TEMPLATE/security.md | 22 +++++++++ CONTRIBUTING.md | 57 +++++++++++++++++++++++ README.md | 1 - 7 files changed, 204 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/ISSUE_TEMPLATE/security.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..32b602d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,50 @@ +--- +name: "Bug report" +about: Report a bug or unexpected behavior in rust-rpxy +title: "[Bug] " +labels: bug +assignees: "" +--- + +## Describe the bug + +A clear and concise description of what the bug is. + +--- + +## To Reproduce + +Steps to reproduce the behavior: + +1. Go to '...' +2. Run '...' +3. See error + +--- + +## Expected behavior + +What did you expect to happen? + +--- + +## Environment + +- rust-rpxy version: +- OS: +- Rust version: +- Configuration file (sanitized if necessary): + +--- + +## Additional context + +Add any other context about the problem here. + +--- + +## Important notes + +- Please provide sufficient detail (logs, configs, reproduction steps). Issues without this may be closed as incomplete. +- This project is maintained on a best-effort basis. +- This project is primarily driven by the code owner's personal interests, not by commercial demand or contractual obligations. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..9714f9c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Security reports + url: ../../security/advisories/new + about: Please report security vulnerabilities via GitHub's private vulnerability reporting. Do not open public issues for security problems. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..537035e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,43 @@ +--- +name: "Feature request" +about: Suggest an idea for rust-rpxy +title: "[Feature] " +labels: enhancement +assignees: "" +--- + +## Feature description + +A clear and concise description of the feature you are requesting. +(What do you want to happen?) + +--- + +## Motivation + +Why is this feature important for your use case? +(Please describe the problem you are facing, not only the desired solution.) + +--- + +## Alternatives considered + +Have you considered any alternatives or workarounds? +(Please describe what you tried, e.g., configuration changes, external tools, or client-side modifications.) + +--- + +## Your contribution + +Would you be willing to: + +- [ ] Submit a Pull Request implementing this feature +- [ ] Sponsor the development (via GitHub Sponsors / other) + +--- + +## Important notes + +- Features that cause compatibility issues or are out of project scope may be declined. +- This project is maintained on a best-effort basis. Requests without contributions (PR or sponsorship) may not be prioritized. +- This project is primarily driven by the code owner's personal interests, not by commercial demand or contractual obligations. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..338981d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,27 @@ +--- +name: "Question" +about: Ask a question about using rust-rpxy +title: "[Question] " +labels: question +assignees: "" +--- + +## Your question + +Clearly describe your question. + +--- + +## Context + +Why are you asking this? Please describe your environment or situation briefly. + +--- + +## Important notes + +- Before opening a Question issue, please also consider using **GitHub Discussions** if your question is more open-ended, opinion-based, or community-related. +- Questions may not always be answered immediately. +- Please check the documentation and existing issues before opening a new one. +- This project is maintained on a best-effort basis. +- This project is primarily driven by the code owner's personal interests, not by commercial demand or contractual obligations. diff --git a/.github/ISSUE_TEMPLATE/security.md b/.github/ISSUE_TEMPLATE/security.md new file mode 100644 index 0000000..b5ebaff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/security.md @@ -0,0 +1,22 @@ +# Security Policy + +## Supported Versions + +Only the latest release of rust-rpxy is actively maintained. +Older versions may not receive security updates. + +## Reporting a Vulnerability + +If you believe you have found a security vulnerability in rust-rpxy: + +- Please use **[GitHub's Private vulnerability reporting](../../security/advisories/new)** feature. +- Do **not** create a public Issue for security problems. + +We will review the report as soon as possible and get back to you. +Please allow a reasonable amount of time for investigation and fixes. + +## Notes + +- This project is primarily maintained based on the code owner's personal interests, not on commercial demand. +- Reports are handled on a best-effort basis. +- If you need guaranteed response times or dedicated support, please consider sponsoring or maintaining your own fork. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7c68b1d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,57 @@ +# Contributing to rust-rpxy + +Thank you for your interest in contributing to rust-rpxy! +This project is maintained primarily based on the code owner's personal interests. +It is not backed by any commercial contract or SLA. Contributions are therefore handled on a **best-effort basis**. + +--- + +## Ways to contribute + +### 1. Reporting issues + +- Use the appropriate Issue template (Bug, Feature request, or Question). +- For questions, please also consider using **GitHub Discussions** instead of Issues. +- Please provide as much detail as possible (logs, configs, environment) to make the report useful. + +### 2. Suggesting new features + +- Feature requests should explain **why** the feature is needed and what alternatives exist. +- Unclear or vague requests may be closed without action. +- Features that introduce compatibility problems or are outside the project scope are unlikely to be accepted. +- If the feature is critical for your environment, please consider: + - Implementing it in your own fork, or + - Sponsoring its development. + +### 3. Submitting code (Pull Requests) + +- Contributions are welcome! Please: + - Ensure code is formatted with `cargo fmt`. + - Run tests with `cargo test` and confirm they pass. + - Keep commits clean and focused. +- Large changes should be discussed in an Issue or Discussion before a PR is submitted. + +### 4. Documentation improvements + +- Fixing typos, clarifying explanations, and improving examples are always appreciated. + +### 5. Security reports + +- Do **not** open public Issues for security vulnerabilities. +- Please report them via [GitHub's Private vulnerability reporting](../../security/advisories/new). +- Reports are handled confidentially and on a best-effort basis. + +--- + +## Code of Conduct + +Be respectful and constructive. +Aggressive, entitled, or hostile communication may result in your Issue or PR being closed without further discussion. + +--- + +## Final notes + +- This project exists because of personal research and interests of the maintainer. +- Time and resources are limited. Contributions that come with clear motivation, good context, or sponsorship are far more likely to be accepted. +- Thank you for understanding and for supporting rust-rpxy! diff --git a/README.md b/README.md index 38a9367..2bfe965 100644 --- a/README.md +++ b/README.md @@ -462,7 +462,6 @@ todo! If you discover a security vulnerability, **do not open a public Issue**. Please use [GitHub's Private vulnerability reporting](../../security/advisories/new) to notify the maintainers. -Reports will be handled on a best-effort basis, as this project is maintained primarily based on the code owner's personal interests. ## Contributing