Skip to content

Commit

Permalink
Add .github
Browse files Browse the repository at this point in the history
  • Loading branch information
sfunkhouser committed Feb 23, 2022
1 parent 66705ff commit 31d9671
Show file tree
Hide file tree
Showing 8 changed files with 269 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# All proposed file changes under the `.github/` folder must be approved by the equinixmetal-buildkite owners team prior to merging
.github/ @equinixmetal-buildkite/owners
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/REPORT_A_BUG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
**Describe the bug**

A clear and concise description of what the bug is.

**To Reproduce**

A list of the steps required to reproduce the issue. Best of all, give us the URL to a repository that exhibits this issue.

**Expected behavior**

A clear and concise description of what you expected to happen.

**Screenshots**

If applicable, add screenshots to help explain your problem.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/REQUEST_A_FEATURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Summary

What change you think needs making.

# Motivation

Please give examples of your use case, e.g. when would you use this.

# Proposal

How do you think this should be implemented?
42 changes: 42 additions & 0 deletions .github/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Configuration for request-info - https://github.com/behaviorbot/request-info

# *OPTIONAL* Comment to reply with
# Can be either a string :
requestInfoReplyComment: >
We would appreciate it if you could provide us with more info about this issue/pr!
# Or an array:
# requestInfoReplyComment:
# - Ah no! young blade! That was a trifle short!
# - Tell me more !
# - I am sure you can be more effusive


# *OPTIONAL* default titles to check against for lack of descriptiveness
# MUST BE ALL LOWERCASE
requestInfoDefaultTitles:
- update readme.md
- updates

# *OPTIONAL* Label to be added to Issues and Pull Requests with insufficient information given
requestInfoLabelToAdd: needs-more-info

# *OPTIONAL* Require Issues to contain more information than what is provided in the issue templates
# Will fail if the issue's body is equal to a provided template
checkIssueTemplate: true

# *OPTIONAL* Require Pull Requests to contain more information than what is provided in the PR template
# Will fail if the pull request's body is equal to the provided template
checkPullRequestTemplate: false

# *OPTIONAL* Only warn about insufficient information on these events type
# Keys must be lowercase. Valid values are 'issue' and 'pullRequest'
requestInfoOn:
pullRequest: true
issue: true

# *OPTIONAL* Add a list of people whose Issues/PRs will not be commented on
# keys must be GitHub usernames
# requestInfoUserstoExclude:
# - hiimbex
# - bexo
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders.

All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
48 changes: 48 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Contributing

Welcome to EquinixMetal-Buildkite Opensource! We're super excited to have you here. This document contains the best practices for contributing to our repositories.

## Filing an Issue

If you are using one of our open source projects- you'll likely begin interacting with us by
filing an issue. Regardless of whether you think the issue is with the project itself, if you're
having trouble using the project, feel free to file an issue on the repo.

**If you have a feature request, please file an issue before making a PR.** Everyone's time is
incredibly valuable, so if you have an idea for a feature, please file an issue. This way we
can have a discussion with you, and the community, about the design, before you have sunk a
bunch of time into developing it.

**You do not need to file an issue for small fixes.** If you are fixing a typo or refactoring
a bit of code, you likely don't need to file an issue. This is a judgement call, and *sometimes*
we may review your PR and ask you to file an issue if we expect there are larger design decisions
to be made.

**Each repository has an Issue Template.** This helps us make sure that you can give us the most
information about your issue upfront, so we can limit the amount of back and forth required
before your issue can be resolved. Do your best to fill it out, but if you have trouble, it's
ok to file an incomplete issue template.

## Making a PR

**If you are considering filing a pull request, make sure that there's an issue filed for the work
you'd like to do.** There might be some discussion required! Filing an issue first will help ensure
that the work you put into your pull request will get merged.

Once your PR is made, 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!


## Conduct

Equinix Opensource follows the [Contributor Covenant Code of Conduct]. You can find a copy in each
of our repositories. Violating the CoC could result in a warning or a ban to any and all repositories
in this organization.

[Contributor Covenant Code of Conduct]: CODE_OF_CONDUCT.md

## Contact

If you have any questions, please reach out to @matoszz (need to change this)
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# .github
# .github

This repo contains shared community resources that will propagate to all public repositories that don't already contain the resource.

You can learn more about this GitHub feature [here](https://help.github.com/en/articles/creating-a-default-community-health-file-for-your-organization).
18 changes: 18 additions & 0 deletions settings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
branches:
- name: main
protection:
required_pull_request_reviews:
required_approving_review_count: 1
dismiss_stale_reviews: true
require_code_owner_reviews: true
dismissal_restrictions:
users: []
teams: []
required_status_checks:
strict: true
contexts: []
enforce_admins: true
restrictions:
apps: []
users: []
teams: []

0 comments on commit 31d9671

Please sign in to comment.