aboutsummaryrefslogtreecommitdiffhomepage
path: root/.github
diff options
context:
space:
mode:
authorYuchen Wu <[email protected]>2024-02-27 20:25:44 -0800
committerYuchen Wu <[email protected]>2024-02-27 20:25:44 -0800
commit8797329225018c4d0ab990166dd020338ae292dc (patch)
tree1e8d0bf6f3c27e987559f52319d91ff75e4da5cb /.github
parent0bca116c1027a878469b72352e1e9e3916e85dde (diff)
downloadpingora-8797329225018c4d0ab990166dd020338ae292dc.tar.gz
pingora-8797329225018c4d0ab990166dd020338ae292dc.zip
Release Pingora version 0.1.0v0.1.0
Co-authored-by: Andrew Hauck <[email protected]> Co-authored-by: Edward Wang <[email protected]>
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md51
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md37
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md27
3 files changed, 115 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..383a2be
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,51 @@
+# Contributing
+
+Welcome to Pingora! Before you make a contribution, be it a bug report, documentation improvement,
+pull request (PR), etc., please read and follow these guidelines.
+
+## Start with filing an issue
+
+More often than not, **start by filing an issue on GitHub**. If you have a bug report or feature
+request, open a GitHub issue. Non-trivial PRs will also require a GitHub issue. The issue provides
+us with a space to discuss proposed changes with you and the community.
+
+Having a discussion via GitHub issue upfront is the best way to ensure your contribution lands in
+Pingora. We don't want you to spend your time making a PR, only to find that we won't accept it on
+a design basis. For example, we may find that your proposed feature works better as a third-party
+module built on top of or for use with Pingora and encourage you to pursue that direction instead.
+
+**You do not need to file an issue for small fixes.** What counts as a "small" or trivial fix is a
+judgment call, so here's a few examples to clarify:
+- fixing a typo
+- refactoring a bit of code
+- most documentation or comment edits
+
+Still, _sometimes_ we may review your PR and ask you to file an issue if we expect there are larger
+design decisions to be made.
+
+## Making a PR
+
+After you've filed an issue, you can make your PR referencing that issue number. Once you open your
+PR, it will be labelled _needs review_. A maintainer will review your PR as soon as they can. The
+reviewer may ask for changes - they will mark the PR as _changes requested_ and _work in progress_
+and will give you details about the requested changes. Feel free to ask lots of questions! The
+maintainers are there to help you.
+
+### Caveats
+
+Currently, internal contributions will take priority. Today Pingora is being maintained by
+Cloudflare's Content Delivery team, and internal Cloudflare proxy services are a primary user of
+Pingora. We value the community's work on Pingora, but the reality is that our team has a limited
+amount of resources and time. We can't promise we will review or address all PRs or issues in a
+timely manner.
+
+## Conduct
+
+Pingora and Cloudflare OpenSource generally follows the [Contributor Covenant Code of Conduct].
+Violating the CoC could result in a warning or a ban to Pingora or any and all repositories in the Cloudflare organization.
+
+[Contributor Covenant Code of Conduct]: https://github.com/cloudflare/.github/blob/26b37ca2ba7ab3d91050ead9f2c0e30674d3b91e/CODE_OF_CONDUCT.md
+
+## Contact
+
+If you have any questions, please reach out to [[email protected]](mailto:[email protected]).
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..434a12e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,37 @@
+---
+name: Bug Report
+about: Report an issue to help us improve
+title: ''
+labels: ''
+assignees: ''
+---
+
+## Describe the bug
+
+A clear and concise description of what the bug is.
+
+## Pingora info
+
+Please include the following information about your environment:
+
+**Pingora version**: release number of commit hash
+**Rust version**: i.e. `cargo --version`
+**Operating system version**: e.g. Ubuntu 22.04, Debian 12.4
+
+## Steps to reproduce
+
+Please provide step-by-step instructions to reproduce the issue. Include any relevant code
+snippets.
+
+## Expected results
+
+What were you expecting to happen?
+
+## Observed results
+
+What actually happened?
+
+## Additional context
+
+What other information would you like to provide? e.g. screenshots, how you're working around the
+issue, or other clues you think could be helpful to identify the root cause.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..cc8d785
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,27 @@
+---
+name: Feature request
+about: Propose a new feature
+title: ''
+labels: ''
+assignees: ''
+---
+
+## What is the problem your feature solves, or the need it fulfills?
+
+A clear and concise description of why this feature should be added. What is the problem? Who is
+this for?
+
+## Describe the solution you'd like
+
+What do you propose to resolve the problem or fulfill the need above? How would you like it to
+work?
+
+## Describe alternatives you've considered
+
+What other solutions, features, or workarounds have you considered that might also solve the issue?
+What are the tradeoffs for these alternatives compared to what you're proposing?
+
+## Additional context
+
+This could include references to documentation or papers, prior art, screenshots, or benchmark
+results.