Skip to content

Commit

Permalink
Adds files to better adhere to community standards
Browse files Browse the repository at this point in the history
  • Loading branch information
StefanKurek committed Sep 14, 2023
1 parent b7b98ec commit 2ca4cfe
Show file tree
Hide file tree
Showing 10 changed files with 160 additions and 1 deletion.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

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

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Environment:**
- OS
- BindPlane Terraform Provider Version or Commit Hash

**Additional context**
Add any other context about the problem here.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!--Important (read before submitting)
In order for changes to be captured in changelog correctly please add one of the following prefixes to the title. **Note** the parenthesis are optional and so is any text in them.
- `feat(OPTIONAL):` = New features
- `fix(OPTIONAL):` = Bug fixes
- `deps(OPTIONAL):` = Dependency updates, primarily dependabot
-->

## Description of Changes

## **Please check that the PR fulfills these requirements**
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been added / updated (for bug fixes / features)
- [ ] CI passes
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]
Copyright 2023 observIQ, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,15 @@ Terraform provider for observIQ's agent management platform, [BindPlane OP](http
## Documentation

See the [documentation](https://registry.terraform.io/providers/observIQ/bindplane/latest/docs) site for information on configuration and usage.

# Community

BindPlane Terraform Provider is an open source project. If you'd like to contribute, take a look at our [contribution guidelines](/docs/CONTRIBUTING.md). We look forward to building with you.

## Code of Conduct

BindPlane Terraform Provider follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). Please report violations of the Code of Conduct to any or all [maintainers](/docs/MAINTAINERS.md).

# Other questions?

Send us an [email](mailto:support@observiq.com), or open an issue with your question. We'd love to hear from you!
3 changes: 3 additions & 0 deletions docs/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# BindPlane Terraform Provider Code of Conduct

BindPlane Terraform Provider follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
26 changes: 26 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing

When contributing to this repository, please first discuss the change you wish to make via an issue with the owners of this repository before making a change.

Please note BindPlane Terraform Provider follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md), please follow it in all your interactions with the project.

## Issue

Please open an issue for your contribution if one does not already exists.

## Pull Request Process

1. Fork it
2. Create your branch (`git checkout -b my-new-feature`).
3. Commit your changes (`git commit -am 'Add some feature'`).
4. Push to the branch (`git push origin my-new-feature`).
5. Create new pull request
6. Link to the issue your pull request resolves.

The pull request title should have one of the following prefixs:
- `feat: `: Features.
- `fix: `: Bug or other Fixes.
- `deps: `: Dependency changes, such as Go modules, container images, Action versions.

If your pull request is not related to one of the three topics, any descriptive title will do. The pull request will
be included in the `Other` category in the release notes.
44 changes: 44 additions & 0 deletions docs/GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Governance

The governance model adopted in BindPlane Terraform Provideris influenced by many CNCF projects.

## Principles

- **Open**: BindPlane Terraform Provider is an open source community.
- **Welcoming and respectful**: BindPlane Terraform Provider follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
- **Transparent and accessible**: Work and collaboration should be done in public.
- **Merit**: Ideas and contributions are accepted according to their technical merit and alignment with project objectives, scope, and design principles.

## Project Maintainers

Maintainers are the first and foremost contributors that are committed to the success of the BindPlane Terraform Provider project. Each maintainer should fulfill several of the following responsibilities:

* Strive to make BindPlane Terraform Provider widely while taking care not to unjustifiably inflate its scope.
* Carefully consider input from the community and seek consensus with amongst maintainers.
* Create and classify GitHub issues and perform pull request reviews for other maintainers and the community.
* Use ones best judgement to apply all applicable [labels](https://github.com/observiq/terraform-provider-bindplane/labels) to each new GitHub issue.
* Make sure that ongoing PRs are moving forward at the right pace or closing them if they are not moving in a productive direction.
* Create releases of the library as necessary.

## Process of becoming a maintainer

* Understand that maintainers are expected to have a deep understanding of the project and that they should be able to independently fulfill maintainer responsibilities.
* Talk to some of the existing [maintainers](MAINTAINERS.md). Explain that you are interested in becoming a maintainer and why you think you are a good fit for the role.
* Contribute increasingly complicated PRs under the guidance of the existing maintainers.
* When a maintainer believes you are ready, he or she may nominate you by creating a PR to add your to the list in [MAINTAINERS.md](MAINTAINERS.md).
* Once the existing maintainers have reached consensus that the nominatee is ready for the role and approved the PR, it will be merged and the new maintainer becomes active.

## Process of removing maintainer status

* If a maintainer is no longer interested or cannot perform the maintainer duties listed above, they should volunteer to be moved to emeritus status.
* In extreme cases a PR may be created to remove a maintainer. This PR must be approved by a 2/3 majority of maintainers to be approved.

## Decision making process

Decisions are made based on consensus between maintainers. Proposals and ideas should be submitted as a github issue or PR.

In general, we prefer that technical issues and maintainer membership are amicably worked out between the persons involved. If a dispute cannot be decided independently, then a third-party maintainer (e.g. a mutual contact with some background on the issue, but not involved in the conflict) to arbitrate and the final decision will be made. Decision making process should be transparent to adhere to the principles of the BindPlane Terraform Provider project.

## Credits

Some contents in this documents have been borrowed from the [OpenYurt](https://github.com/alibaba/openyurt) project.
9 changes: 9 additions & 0 deletions docs/MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# The BindPlane Terraform Provider Maintainers

This file lists the maintainers of the BindPlane Terraform Provider project. The responsibilities of maintainers are listed in the [GOVERNANCE.md](GOVERNANCE.md) file.

## Project Maintainers
| Name | GitHub ID | Affiliation |
| ---- | --------- | ----------- |
| [Joe Sirianni](mailto:joe.sirianni@observiq.com) | [jsirianni](https://github.com/jsirianni) | observIQ |
| [Corbin Phelps](mailto:corbin.phelps@observiq.com) | [cpheps](https://github.com/cpheps) | observIQ |

0 comments on commit 2ca4cfe

Please sign in to comment.