Skip to content

Commit

Permalink
added code of conduct, maintainers, contributing guidelines, and slack
Browse files Browse the repository at this point in the history
  • Loading branch information
ogazitt committed Oct 23, 2022
1 parent f80da4b commit dcc868f
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 0 deletions.
1 change: 1 addition & 0 deletions CODE_OF_CONDUCT.md
@@ -0,0 +1 @@
This project follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,21 @@
# Contributing to Topaz

Welcome, and thank you for considering contributing to Topaz. We encourage
you to help out by raising issues, improving documentation, fixing bugs, or
adding new features

If you're interested in contributing please start by reading this document. If you have any questions at all, or don't know where to start, please reach out to us on [Slack](SLACK). Please also take a look at our [code of conduct](CODE_OF_CONDUCT), which details how contributors are expected to conduct themselves as part of the Topaz community.

## Contributing Code

To contribute bug fixes or features to Topaz:

1. Communicate your intent.
1. Make your changes.
1. Test your changes.
1. Update documentation and examples where appropriate.
1. Open a Pull Request (PR).

Communicating your intent lets the Topaz maintainers know that you intend
to contribute, and how. This sets you up for success - you can avoid duplicating effort that may already be underway, adding a feature that may be rejected, or heading down a path that you would be steered away from at review time. The best way to communicate your intent is via a detailed GitHub issue. Take a look first to see if there's already an issue relating to the thing you'd like to contribute. If there isn't, please raise a new one! Let us know what you'd like to work on, and why. The Topaz maintainers can't always triage new issues immediately, but we encourage you to bring them to our attention via [Slack](SLACK).

8 changes: 8 additions & 0 deletions MAINTAINERS.md
@@ -0,0 +1,8 @@
# Maintainers

The following table lists Open Policy Registry (OPCR) project maintainers and areas of expertise in alphabetical order:

| Name | GitHub | Email | Organization | Repositories/Area of Expertise | Added/Renewed On |
| --- | --- | --- | --- | --- | --- |
| Gert Drapers | @gertd | gert@aserto.com | Aserto | all repositories | 2021-09-28 |
| Vlad Iovanov | @viovanov | vlad@aserto.com | Aserto | all repositories | 2021-09-28 |
31 changes: 31 additions & 0 deletions SLACK.md
@@ -0,0 +1,31 @@
# Open Policy Registry (OPCR) Slack Guidelines

The [CNCF Code of
Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md)
applies in all areas in addition to these rules:

## Channel Spamming

Outside of the issue queues, Slack is our best communication medium for
projects. Please keep your messages on topic for each channel, and please use
the appropriate channel. Please do not cross-post. Spamming channels with
unsolicited or frequent messages is not allowed.

## Vendor Advertisements

This workspace is intended for conversations related to OPCR
projects. Please do not use the Slack to advertise proprietary vendor products,
services, webinars, blogs, etc.

## Reporting a Problem

Please report issues to Vlad Iovanov (vlad@aserto.com or @viovanov) or Gert
Drapers (gert@aserto.com).

## Consequences of Unacceptable Behavior

Unacceptable behavior from any community member will not be tolerated. If a
community member engages in unacceptable behavior, an admin may take any action
deemed appropriate, up to and including a warning or temporary 30 day ban, along
with a permanent ban for repeated violation of these guidelines. Admins may also
remove content that violates the above guidelines.

0 comments on commit dcc868f

Please sign in to comment.