Skip to content

Commit e036ca5

Browse files
committed
Add CoC, Contributing and Security markdown
1 parent f3ef434 commit e036ca5

File tree

3 files changed

+185
-0
lines changed

3 files changed

+185
-0
lines changed

CODE_OF_CONDUCT.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies within all project spaces, and it also applies when
49+
an individual is representing the project or its community in public spaces.
50+
Examples of representing a project or community include using an official
51+
project e-mail address, posting via an official social media account, or acting
52+
as an appointed representative at an online or offline event. Representation of
53+
a project may be further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [[email protected]][conduct-email]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
[conduct-email]: mailto:[email protected]
69+
70+
## Attribution
71+
72+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
73+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
74+
75+
[homepage]: https://www.contributor-covenant.org
76+
77+
For answers to common questions about this code of conduct, see
78+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# How to Contribute
2+
3+
Thank you for your interest in contributing to the dCloud Terraform Provider project! To ensure smooth collaboration and effective development, please review the following guidelines. By following these guidelines, you demonstrate respect for the time and efforts of the project's contributors. In return, they will reciprocate by addressing your issues, evaluating changes, and assisting with your pull requests. We strive to review incoming issues and pull requests within 10 days. Any lingering issues or pull requests inactive for 60 days will be closed.
4+
5+
Please note that all interactions within the project are subject to our [Code of Conduct](/CODE_OF_CONDUCT.md). This applies to creating issues or pull requests, commenting on them, as well as any real-time discussions in platforms like Slack, Discord, etc.
6+
7+
## Table Of Contents
8+
9+
- [Troubleshooting and Debugging](#troubleshooting-and-debugging)
10+
- [Reporting Issues](#reporting-issues)
11+
- [Development](#development)
12+
- [Setting up the Development Environment](#setting-up-the-development-environment)
13+
- [Building the dCloud Terraform Provider](#building-the-dcloud-topology-builder-go-client)
14+
- [Running Tests](#running-tests)
15+
- [Sending Pull Requests](#sending-pull-requests)
16+
- [Other Ways to Contribute](#other-ways-to-contribute)
17+
18+
## Reporting Issues
19+
20+
Before reporting a new issue, please search our [issues list](https://github.com/cisco-open/kapua-tb-go-client/issues) to ensure that it hasn't already been reported or fixed.
21+
22+
When creating a new issue, include a clear title, a detailed description, relevant information, and if possible, a test case.
23+
24+
**If you discover a security vulnerability, please refrain from reporting it through GitHub. Instead, follow the security procedures outlined in [SECURITY.md](/SECURITY.md).**
25+
26+
## Development
27+
28+
### Setting up the Development Environment
29+
30+
To set up your development environment for the dCloud Terraform Provider, follow the instructions below:
31+
32+
1. Clone the repository: `git clone https://github.com/cisco-open/terraform-provider-dcloudtb.git`
33+
2. Navigate to the project directory: `terraform-provider-dcloudtb`
34+
3. Install the necessary dependencies: https://go.dev/doc/install, https://developer.hashicorp.com/terraform
35+
36+
### Building the dCloud Terraform Provider
37+
38+
To build the dCloud Terraform Provider, execute the following steps:
39+
40+
1. Install Go
41+
2. Execute the following from the root of the repository: `go build .`
42+
43+
### Running Examples
44+
45+
To run the example terraform definitions for the dCloud Terraform Provider, do the following:
46+
47+
1. Navigate to each example directory under `/examples`
48+
2. Execute `terraform init`
49+
3. Create an environment variable to hold your Cisco Authentication Token (use a valid token) `export TB_AUTH_TOKEN=abc123`
50+
4. Execute `terraform apply`
51+
52+
## Sending Pull Requests
53+
54+
Before submitting a new pull request, please check existing pull requests and issues to ensure that your proposed changes or fixes haven't been discussed in the past or already implemented but not released.
55+
56+
When submitting a pull request, include tests for any affected behavior. As we follow semantic versioning, breaking changes may be reserved for the next major version release.
57+
58+
## Other Ways to Contribute
59+
60+
We welcome contributions beyond code. Here are some ways you can contribute to the dCloud Terraform Provider project:
61+
62+
- Help triage and respond to open issues, providing troubleshooting assistance and suggesting fixes.
63+
- Review existing pull requests and test patches against real applications that use the dCloud Terraform Provider.
64+
- Write new tests or add missing test cases to existing tests.
65+
66+
Thank you for your interest in contributing to the dCloud Terraform Provider project!
67+
68+
:heart:

SECURITY.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Security Policies and Procedures
2+
3+
This document outlines security procedures and general policies for the
4+
dCloud Terraform Provider project.
5+
6+
- [Reporting a Bug](#reporting-a-bug)
7+
- [Disclosure Policy](#disclosure-policy)
8+
- [Comments on this Policy](#comments-on-this-policy)
9+
10+
## Reporting a Bug
11+
12+
The dCloud Terraform Provider team and community take all security bugs in
13+
the dCloud Terraform Provider seriously. Thank you for improving the security of the
14+
dCloud Terraform Provider. We appreciate your efforts and responsible disclosure and
15+
will make every effort to acknowledge your contributions.
16+
17+
Report security bugs by emailing `[email protected]`.
18+
19+
The lead maintainer will acknowledge your email within 48 hours, and will send a
20+
more detailed response within 48 hours indicating the next steps in handling
21+
your report. After the initial reply to your report, the security team will
22+
endeavor to keep you informed of the progress towards a fix and full
23+
announcement, and may ask for additional information or guidance.
24+
25+
## Disclosure Policy
26+
27+
When the security team receives a security bug report, they will assign it to a
28+
primary handler. This person will coordinate the fix and release process,
29+
involving the following steps:
30+
31+
- Confirm the problem and determine the affected versions.
32+
- Audit code to find any potential similar problems.
33+
- Prepare fixes for all releases still under maintenance. These fixes will be
34+
released as quickly as possible.
35+
36+
## Comments on this Policy
37+
38+
If you have suggestions on how this process could be improved please submit a
39+
pull request.

0 commit comments

Comments
 (0)