Skip to content

Commit e78af1a

Browse files
committed
Add license headers
1 parent dcce15d commit e78af1a

File tree

435 files changed

+7499
-48
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

435 files changed

+7499
-48
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# 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 making 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 both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
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 sending an email to [email protected]. 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+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# How to Contribute
2+
3+
Thanks for your interest in contributing to this Terraform provider! Here are a few general guidelines on contributing and
4+
reporting bugs that we ask you to review. Following these guidelines helps to communicate that you respect the time of
5+
the contributors managing and developing this open source project. In return, they should reciprocate that respect in
6+
addressing your issue, assessing changes, and helping you finalize your pull requests. In that spirit of mutual respect,
7+
we endeavor to review incoming issues and pull requests within 10 days, and will close any lingering issues or pull
8+
requests after 60 days of inactivity.
9+
10+
Please note that all of your interactions in the project are subject to our [Code of Conduct](/CODE_OF_CONDUCT.md). This
11+
includes creation of issues or pull requests, commenting on issues or pull requests, and extends to all interactions in
12+
any real-time space e.g., Slack, Discord, etc.
13+
14+
## Table Of Contents
15+
16+
- [Reporting Issues](#reporting-issues)
17+
- [Development](#development)
18+
- [Building the Provider](#building-the-provider)
19+
- [Acceptance Tests](#acceptance-tests)
20+
- [Sending Pull Requests](#sending-pull-requests)
21+
- [Other Ways to Contribute](#other-ways-to-contribute)
22+
23+
## Reporting Issues
24+
25+
Before reporting a new issue, please ensure that the issue was not already reported or fixed by searching through our
26+
[issues list](https://github.com/CiscoDevNet/terraform-provider-iosxr/issues).
27+
28+
When creating a new issue, please be sure to include a **title and clear description**, as much relevant information as
29+
possible, and, if possible, a test case.
30+
31+
**If you discover a security bug, please do not report it through GitHub. Instead, please see security procedures in
32+
[SECURITY.md](/SECURITY.md).**
33+
34+
## Development
35+
36+
### Building the Provider
37+
38+
1. Clone the repository
39+
2. Enter the repository directory
40+
3. Build the provider using the Go `install` command:
41+
42+
```shell
43+
go install
44+
```
45+
46+
### Acceptance Tests
47+
48+
In order to run the full suite of Acceptance tests, run `make testacc`. Make sure the respective environment variables are set (e.g., `IOSXR_USERNAME`, `IOSXR_PASSWORD`, `IOSXR_HOST`).
49+
50+
Note: Acceptance tests create real resources.
51+
52+
```shell
53+
make testacc
54+
```
55+
56+
## Sending Pull Requests
57+
58+
Before sending a new pull request, take a look at existing pull requests and issues to see if the proposed change or fix
59+
has been discussed in the past, or if the change was already implemented but not yet released.
60+
61+
We expect new pull requests to include tests for any affected behavior, and, as we follow semantic versioning, we may
62+
reserve breaking changes until the next major version release.
63+
64+
## Other Ways to Contribute
65+
66+
We welcome anyone that wants to contribute to this Terraform provider to triage and reply to open issues to help troubleshoot
67+
and fix existing bugs. Here is what you can do:
68+
69+
- Help ensure that existing issues follows the recommendations from the _[Reporting Issues](#reporting-issues)_ section,
70+
providing feedback to the issue's author on what might be missing.
71+
- Review existing pull requests, and testing patches against real infrastructure.
72+
- Write a test, or add a missing test case to an existing test.
73+
74+
Thanks again for your interest on contributing to this Terraform provider!
75+
76+
:heart:

SECURITY.md

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

gen/doc_category.go

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
// Copyright © 2023 Cisco Systems, Inc. and its affiliates.
2+
// All rights reserved.
3+
//
4+
// Licensed under the Mozilla Public License, Version 2.0 (the "License");
5+
// you may not use this file except in compliance with the License.
6+
// You may obtain a copy of the License at
7+
//
8+
// https://mozilla.org/MPL/2.0/
9+
//
10+
// Unless required by applicable law or agreed to in writing, software
11+
// distributed under the License is distributed on an "AS IS" BASIS,
12+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
// See the License for the specific language governing permissions and
14+
// limitations under the License.
15+
//
16+
// SPDX-License-Identifier: MPL-2.0
17+
118
//go:build ignore
219

320
package main

gen/generator.go

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
// Copyright © 2023 Cisco Systems, Inc. and its affiliates.
2+
// All rights reserved.
3+
//
4+
// Licensed under the Mozilla Public License, Version 2.0 (the "License");
5+
// you may not use this file except in compliance with the License.
6+
// You may obtain a copy of the License at
7+
//
8+
// https://mozilla.org/MPL/2.0/
9+
//
10+
// Unless required by applicable law or agreed to in writing, software
11+
// distributed under the License is distributed on an "AS IS" BASIS,
12+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
// See the License for the specific language governing permissions and
14+
// limitations under the License.
15+
//
16+
// SPDX-License-Identifier: MPL-2.0
17+
118
//go:build ignore
219

320
package main

gen/load_models.go

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
// Copyright © 2023 Cisco Systems, Inc. and its affiliates.
2+
// All rights reserved.
3+
//
4+
// Licensed under the Mozilla Public License, Version 2.0 (the "License");
5+
// you may not use this file except in compliance with the License.
6+
// You may obtain a copy of the License at
7+
//
8+
// https://mozilla.org/MPL/2.0/
9+
//
10+
// Unless required by applicable law or agreed to in writing, software
11+
// distributed under the License is distributed on an "AS IS" BASIS,
12+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
// See the License for the specific language governing permissions and
14+
// limitations under the License.
15+
//
16+
// SPDX-License-Identifier: MPL-2.0
17+
118
//go:build ignore
219

320
package main

gen/templates/data_source.go

Lines changed: 17 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

gen/templates/data_source_test.go

Lines changed: 17 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)