3pp-mirror/pomerium
1
0
Fork 0
mirror of https://github.com/pomerium/pomerium.git synced 2025-05-31 01:47:33 +02:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #265 from desimone/docs/add-community-details

Browse source 
docs: add mailing list and twitter
This commit is contained in:
Bobby DeSimone 2019-08-14 15:22:15 -07:00 • committed by GitHub
commit 7d41431e3b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/community/readme.md
View file

@ -1,15 +1,23 @@
---
title: Overview
description: >-
This document describes how you can find issues to work on, setup Pomerium
locally for development, and get help when you are stuck.
This document describes how you users can stay up to date with pomerium,
report issues, get help, and suggest new features.
---
# Get help
# Community
## Get updates
[Pomerium-announce](https://groups.google.com/forum/#!forum/pomerium-announce) is is low traffic mailing list for important release and security announcements. We encourage all Pomerium users to subscribe to pomerium-announce.
On Twitter, we are [@pomerium_io](https://twitter.com/pomerium_io).
## Get help
If you have a question about using Pomerium, [join our slack channel](http://slack.pomerium.io/)! There will be more people there who can help you than just the Pomerium developers who follow our issue tracker. Issues are not the place for usage questions.
# Report bugs
## Report bugs
Like every software, Pomerium has its flaws. If you find one, [search the issues](https://github.com/pomerium/pomerium/issues) to see if it has already been reported. If not, [open a new issue](https://github.com/pomerium/pomerium/issues/new) and describe the bug, and somebody will look into it!
@ -17,8 +25,8 @@ Please follow the issue template so we have all the needed information. We need
We suggest reading [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html).
# Suggest features
## Suggest features
First, [search to see if your feature has already been requested](https://github.com/pomerium/pomerium/issues). If it has, you can add a :+1: reaction to vote for it. If your feature idea is new, open an issue to request the feature. You don't have to follow the bug template for feature requests. Please describe your idea thoroughly so that we know how to implement it! Really vague requests may not be helpful or actionable and without clarification will have to be closed.
While we really do value your requests and implement many of them, not all features are a good fit for Pomerium. But if a feature is not in the best interest of the Pomerium project or its users in general, we may politely decline to implement it into Pomerium core.
While we really do value your requests and implement many of them, not all features are a good fit for Pomerium. But if a feature is not in the best interest of the Pomerium project or its users in general, we may politely decline to implement it.