Skip to content

Commit e515f5f

Browse files
dhurleydhurley
authored
Added copyright headers. Cleaned up of repo. (#27)
Co-authored-by: Donal Hurley <[email protected]>
1 parent f785bfa commit e515f5f

29 files changed

+573
-301
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
### Describe the bug
9+
10+
A clear and concise description of what the bug is.
11+
12+
### To reproduce
13+
14+
Steps to reproduce the behavior:
15+
16+
1. Deploy {{REPOSITORY_NAME}} using
17+
2. View output/logs/configuration on '...'
18+
3. See error
19+
20+
### Expected behavior
21+
22+
A clear and concise description of what you expected to happen.
23+
24+
### Your environment
25+
26+
- Version of the {{REPOSITORY_NAME}} or specific commit
27+
<!-- - Version of project language -->
28+
- Target deployment platform
29+
30+
### Additional context
31+
32+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
### Is your feature request related to a problem? Please describe
9+
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when ...
11+
12+
### Describe the solution you'd like
13+
14+
A clear and concise description of what you want to happen.
15+
16+
### Describe alternatives you've considered
17+
18+
A clear and concise description of any alternative solutions or features you've considered.
19+
20+
### Additional context
21+
22+
Add any other context or screenshots about the feature request here.

‎.github/pull_request_template.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
### Proposed changes
2+
3+
Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to that issue using one of the [supported keywords](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) here in this description (not in the title of the PR).
4+
5+
### Checklist
6+
7+
Before creating a PR, run through this checklist and mark each as complete.
8+
9+
- [ ] I have read the [`CONTRIBUTING`](https://github.com/nginxinc/nginx-go-crossplane/blob/main/CONTRIBUTING.md) document
10+
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works
11+
- [ ] If applicable, I have checked that any relevant tests pass after adding my changes
12+
- [ ] I have updated any relevant documentation ([`README.md`](https://github.com/nginxinc/nginx-go-crossplane/blob/main/README.md))

‎.github/workflows/fossa.yml

-24
This file was deleted.

‎.gitlab-ci.yml

-35
This file was deleted.

‎CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @nginxinc/plaform-tech-leads

‎CODE_OF_CONDUCT.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
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 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 contacting the moderation team at [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](https://www.contributor-covenant.org), version 1.4,
71+
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
72+
73+
For answers to common questions about this code of conduct, see
74+
<https://www.contributor-covenant.org/faq>

‎CONTRIBUTING.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributing Guidelines
2+
3+
The following is a set of guidelines for contributing to the {{REPOSITORY_NAME}}. We really appreciate that you are considering contributing!
4+
5+
#### Table Of Contents
6+
7+
[Getting Started](#getting-started)
8+
9+
[Contributing](#contributing)
10+
11+
[Code Guidelines](#code-guidelines)
12+
13+
[Code of Conduct](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/CODE_OF_CONDUCT.md)
14+
15+
## Getting Started
16+
17+
Follow our [Installation Guide](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/README.md#Installation) to get the {{REPOSITORY_NAME}} up and running.
18+
19+
<!-- ### Project Structure (OPTIONAL) -->
20+
21+
## Contributing
22+
23+
### Report a Bug
24+
25+
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report using our security policy.**
26+
27+
### Suggest a Feature or Enhancement
28+
29+
To suggest a feature or enhancement, please create an issue on GitHub with the label `feature` or `enhancement` using the available feature request issue template. Please ensure the feature or enhancement has not already been suggested.
30+
31+
### Open a Pull Request
32+
33+
* Fork the repo, create a branch, implement your changes, add any relevant tests, submit a PR when your changes are **tested** and ready for review.
34+
* Fill in [our pull request template](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/.github/pull_request_template.md).
35+
36+
Note: if you'd like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature.
37+
38+
## Code Guidelines
39+
40+
<!-- ### Go/Python/Bash Guidelines (OPTIONAL) -->
41+
42+
### Git Guidelines
43+
44+
* Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
45+
* If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format when writing a commit message, so that changelogs can be automatically generated
46+
* Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarised in the next few points:
47+
* In the subject line, use the present tense ("Add feature" not "Added feature").
48+
* In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
49+
* Limit the subject line to 67 characters or less.
50+
* Limit the rest of the commit message to 72 characters or less.
51+
* Reference issues and pull requests liberally after the subject line.
52+
* Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`).

0 commit comments

Comments
 (0)