Skip to content
This repository has been archived by the owner on Nov 8, 2022. It is now read-only.

Commit

Permalink
Merge pull request #1350 from kjlyon/maintainer-policy
Browse files Browse the repository at this point in the history
Updated maintainer information
  • Loading branch information
mbbroberg authored Nov 18, 2016
2 parents 9e94389 + 5a1ef6f commit b5483d4
Show file tree
Hide file tree
Showing 4 changed files with 86 additions and 56 deletions.
28 changes: 10 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,10 @@ limitations under the License.
4. [Community Support](#community-support)
5. [Contributing](#contributing)
* [Author a Plugin](#author-a-plugin)
* [Become a Maintainer](#become-a-maintainer)
6. [Code of Conduct](#code-of-conduct)
7. [Security Disclosure](#security-disclosure)
8. [License](#license)
9. [Contributors](#contributors)
* [Initial Authors](#initial-authors)
* [Maintainers](#maintainers)
10. [Thank You](#thank-you)

## Overview
Expand Down Expand Up @@ -94,7 +92,7 @@ Snap does not have external dependencies since it is compiled into a statically

### Installation

You can obtain Linux RPM/Deb packages from [Snap's packagecloud.io respository](https://packagecloud.io/intelsdi-x/snap). Snap binaries in `.tar.gz` bundles and MacOS `.pkg` installer are available at Snap's [GitHub release page](https://github.com/intelsdi-x/snap/releases).
You can obtain Linux RPM/Deb packages from [Snap's packagecloud.io repository](https://packagecloud.io/intelsdi-x/snap). Snap binaries in `.tar.gz` bundles and MacOS `.pkg` installer are available at Snap's [GitHub release page](https://github.com/intelsdi-x/snap/releases).

RedHat 6/7:
```
Expand Down Expand Up @@ -167,7 +165,7 @@ To view the service logs:
$ tail -f /var/log/snap/snapd.log
```

By default Snap daemon will be running in standalone mode and listening on port 8181. To enable gossip mode, checkout the [tribe documentation](docs/TRIBE.md). For additional configuration options such as plugin signing and port configuration see [snapd documentation](docs/SNAPD.md).
By default, Snap daemon will be running in standalone mode and listening on port 8181. To enable gossip mode, checkout the [tribe documentation](docs/TRIBE.md). For additional configuration options such as plugin signing and port configuration see [snapd documentation](docs/SNAPD.md).


### Load Plugins
Expand Down Expand Up @@ -320,7 +318,7 @@ We encourage contributions from the community. Snap needs:
* _Feedback_: try it and tell us about it on [our Slack team](https://intelsdi-x.herokuapp.com/), through [a blog posts](https://medium.com/intel-sdi/) or Twitter with #SnapTelemetry
* _Integrations_: Snap can collect from and publish to almost anything by [authoring a plugin](#author-a-plugin)

To contribute to the Snap framework, see [our CONTRIBUTING file](CONTRIBUTING.md). To give back to a specific plugin, open an issue on its repository.
To contribute to the Snap framework, see our [CONTRIBUTING.md](CONTRIBUTING.md) file. To give back to a specific plugin, open an issue on its repository. Snap maintainers aim to address comments and questions as quickly as possible. To get some attention on an issue, reach out to us [on Slack](http://slack.snap-telemetry.io), or open an issue to get a conversation started.


### Author a Plugin
Expand All @@ -330,27 +328,21 @@ The power of Snap comes from its open architecture and its growing community of

Add to the ecosystem by building your own plugins to collect, process or publish telemetry.

### Become a Maintainer
Snap maintainers are here to help guide Snap, the plugins, and the community forward in a positive direction. Maintainers of Snap and the Intel created plugins are selected based on contributions to the project and recommendations from other maintainers. The full list of active maintainers can be found [here](docs/MAINTAINERS.md).

Interested in becoming a maintainer? Check out [Responsibilities of a Maintainer](docs/MAINTAINERS.md#responsibilities-of-maintainers) and open an issue [here](https://github.com/intelsdi-x/snap/issues/new?title=interested+in+becoming+a+maintainer&body=About+me) to discuss your interest.

## Code of Conduct
All contributors to Snap are expected to be helpful and encouraging to all members of the community, treating everyone with a high level of professionalism and respect. See our [code of conduct](CODE_OF_CONDUCT.md) for more details.

## Security Disclosure

The Snap team take security very seriously. If you have any issue regarding security, please notify us by sending an email to snap-security@intel.com
The Snap team takes security very seriously. If you have any issue regarding security, please notify us by sending an email to snap-security@intel.com
and not by creating a GitHub issue. We will follow up with you promptly with more information and a plan for remediation.

## License
Snap is Open Source software released under the [Apache 2.0 License](LICENSE).

## Contributors
### Initial Authors
All contributors are equally important to us, but we would like to thank the [initial authors](AUTHORS.md#initial-authors) for helping make open sourcing Snap possible.

### Maintainers
Amongst the many awesome contributors, there are the maintainers. These maintainers may change over time, but they are all members of the **@intelsdi-x/snap-maintainers** team. This group will help you by:
* Committing to reviewing pull requests, issues, and addressing comments/questions as quickly as possible
* Acting as a point of contact for questions

Just tag **@intelsdi-x/snap-maintainers** if you need to get some attention on an issue. If at any time, you don't get a quick enough response, reach out to us [on Slack](http://slack.snap-telemetry.io)

## Thank You
And **thank you!** Your contribution, through code and participation, is incredibly important to us.
22 changes: 22 additions & 0 deletions docs/AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Initial Authors

[@andrzej-k](https://github.com/andrzej-k)
[@candysmurf](https://github.com/candysmurf)
[@ConnorDoyle](https://github.com/ConnorDoyle)
[@danielscottt](https://github.com/danielscottt)
[@dasm](https://github.com/dasm)
[@geauxvirtual](https://github.com/geauxvirtual)
[@IzabellaRaulin](https://github.com/IzabellaRaulin)
[@jcooklin](https://github.com/jcooklin)
[@Lactem](https://github.com/Lactem)
[@lmroz](https://github.com/lmroz)
[@lynxbat](https://github.com/lynxbat)
[@marcin-krolik](https://github.com/marcin-krolik)
[@mjbrender](https://github.com/mjbrender)
[@nqn](https://github.com/nqn)
[@PatrykMatyjasek](https://github.com/PatrykMatyjasek)
[@ppalucki](https://github.com/ppalucki)
[@sandlbn](https://github.com/sandlbn)
[@shweta1989](https://github.com/shweta1989)
[@skonefal](https://github.com/skonefal)
[@tiffanyfj](https://github.com/tiffanyfj)
38 changes: 0 additions & 38 deletions docs/MAINTAINERS

This file was deleted.

54 changes: 54 additions & 0 deletions docs/MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Maintainers

Among our many awesome contributors, Snap has a great team of maintainers. Maintainers are expected to have a solid understanding of Snap and are here to help guide Snap, the plugins and the community forward in a positive direction.

All maintainers and members of the community are expected to be helpful and encouraging. Treating everyone with a high level of professionalism and respect is a top priority for us. See our [CODE_OF_CONDUCT](../CODE_OF_CONDUCT.md) for further explanation of our policies.

If you're interested in joining the team as a maintainer, check out the [becoming a maintainer](../README.md#become-a-maintainer) section of our README.

----

## Technical Lead: Joel Cooklin (@jcooklin)
While our maintainers guide Snap, the plugins, and the community forward in a positive direction, our technical lead, Joel, is the key decision maker and fearless leaders for all of us. If there is ever a debate within the project, Joel is the tiebreaker.

## Snap Maintainers
Below is the list of Snap Maintainers, they are largely responsible for approving pull requests and thus have the final say on coding style and implementation.

| Name | Tag |
|:------------------|:-------------------|
| Andrzej Kuriata | @andrzej-k |
| Cody Roseborough | @IRCody s |
| Emily Gu | @candysmurf |
| Izabella Raulin | @IzabellaRaulin |
| Joel Cooklin | @jcooklin |
| Katarzyna Kujawa | @katarzyna-z |
| Kelly Lyon | @kjlyon |
| Lukasz Mroz | @lmroz |
| Marcin Krolik | @marcin-krolik |
| Marcin Olszewski | @marcintao |
| Marcin Spoczynski | @sandlbn |
| Maria Rolbiecka | @mkuculyma |
| Mateusz Kleina | @mkleina |
| Matt Brender | @mjbrender |
| Nicholas Weaver | @lynxbat |
| Olivier Cano | @kindermoumoute |
| Patryk Matyjasek | @PatryMatyjasek |
| Rashmi Gottipati | @rashmigottipati |

### Responsibilities of Snap Maintainers
Maintainers are expected to contribute regularly in at least one of the following capacities:
* Direction/Design: Meaningfully contributing to RFC or design comments
* Code Contributions: Submitting pull requests for either bug fixes or features
* Support: Active participation in a support role in some form (code reviews, addressing questions, triaging issues)

If a maintainer is consistently unable to perform the above actions they will be asked to withdraw from the maintainer group. This does not preclude them from becoming a maintainer at a later date.

## Initial Authors
All contributors are equally important to us, but we would like to thank the [initial authors](AUTHORS.md#initial-authors) for helping make open sourcing Snap possible.

## Contact Us
Contacting us is easy! Use these simple tips for the most effective communication with us.
* **For a quick question:** reach out to us on [Slack](https://intelsdi-x.herokuapp.com/). You can search by GitHub handles and ping individual users, start a group conversation, and post to the Snap community. Maintainers check this regularly and will be the fastest way of contacting us.
* **If you find a bug in the code or have a question about some code:** go ahead and [open up a GitHub issue](https://github.com/intelsdi-x/snap/issues). This will start a dialog. If you don't know how to solve the issue we will pick it up and help fix the bug.
* **To get a specific person's attention:** @mention them in an issue and they will get back to you.
* **For plugin related issues:** contact the plugin's author or reach out to a maintainer.

0 comments on commit b5483d4

Please sign in to comment.