Skip to content
This repository was archived by the owner on May 24, 2023. It is now read-only.

Commit 3dfe039

Browse files
author
Raul Marrero
committed
Initial operator working
1 parent 720cac5 commit 3dfe039

Some content is hidden

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

56 files changed

+5044
-1
lines changed

Diff for: .github/ISSUE_TEMPLATE/bug_report.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
**Describe the bug**
8+
A clear and concise description of what the bug is.
9+
10+
**To Reproduce**
11+
Steps to reproduce the behavior:
12+
1. Deploy x to '...' using some.yaml
13+
2. View logs on '....'
14+
3. See error
15+
16+
**Expected behavior**
17+
A clear and concise description of what you expected to happen.
18+
19+
**Your environment**
20+
* Version of the NGINX Ingress Operator - release version or a specific commit
21+
* Version of the Ingress Controller - release version or a specific commit
22+
* Version of Kubernetes
23+
* Kubernetes platform (e.g. Mini-kube or GCP)
24+
* Using NGINX or NGINX Plus
25+
26+
**Additional context**
27+
Add any other context about the problem here. Any log files you want to share.

Diff for: .github/ISSUE_TEMPLATE/feature_request.md

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

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
### Proposed changes
2+
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 here in this description (not in the title of the PR).
3+
4+
### Checklist
5+
Before creating a PR, run through this checklist and mark each as complete.
6+
7+
- [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/nginx-ingress-operator/blob/master/CONTRIBUTING.md) doc
8+
- [ ] I have added tests that prove my fix is effective or that my feature works
9+
- [ ] I have checked that all unit tests pass after adding my changes
10+
- [ ] I have updated necessary documentation
11+
- [ ] I have rebased my branch onto master
12+
- [ ] I will ensure my PR is targeting the master branch and pulling from my branch from my own fork

Diff for: .gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -75,3 +75,4 @@ tags
7575
.vscode/*
7676
.history
7777
# End of https://www.gitignore.io/api/go,vim,emacs,visualstudiocode
78+
.DS_Store

Diff for: CODE_OF_CONDUCT.md

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

Diff for: CONTRIBUTING.md

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Contributing Guidelines
2+
3+
The following is a set of guidelines for contributing to the NGINX Ingress Operator. We really appreciate that you are considering contributing!
4+
5+
#### Table Of Contents
6+
7+
[Ask a Question](#ask-a-question)
8+
9+
[Getting Started](#getting-started)
10+
11+
[Contributing](#contributing)
12+
13+
[Style Guides](#style-guides)
14+
* [Git Style Guide](#git-style-guide)
15+
* [Go Style Guide](#go-style-guide)
16+
17+
[Code of Conduct](https://github.com/nginxinc/nginx-ingress-operator/blob/master/CODE_OF_CONDUCT.md)
18+
19+
## Ask a Question
20+
21+
Please open an Issue on GitHub with the label `question`.
22+
23+
## Getting Started
24+
25+
Follow our [Installation Guide](https://github.com/nginxinc/nginx-ingress-operator/blob/master/docs/installation.md) to get the NGINX Ingress Operator up and running.
26+
27+
Read the [documentation](https://github.com/nginxinc/nginx-ingress-operator/tree/master/docs) and [examples](https://github.com/nginxinc/nginx-ingress-operator/tree/master/examples).
28+
29+
### Project Structure
30+
31+
* This Operator is written in Go using the operator-framework and supports both the open source NGINX Ingress Controller and NGINX Plus Ingress Controller.
32+
* The project follows a standard Go project layout
33+
* The main code is found at `cmd/manager/`
34+
* The operator code is found at `pkg/`
35+
* Build files for Docker and CI are found under `build/`
36+
* We use [Go Modules](https://github.com/golang/go/wiki/Modules) for managing dependencies.
37+
38+
## Contributing
39+
40+
### Report a Bug
41+
42+
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the issue has not already been reported.
43+
44+
### Suggest an Enhancement
45+
46+
To suggest an enhancement, please create an issue on GitHub with the label `enhancement` using the available feature issue template.
47+
48+
### Open a Pull Request
49+
50+
* Fork the repo, create a branch, submit a PR when your changes are tested and ready for review
51+
* Fill in [our pull request template](https://github.com/nginxinc/nginx-ingress-operator/blob/master/.github/PULL_REQUEST_TEMPLATE.md)
52+
53+
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.
54+
55+
## Style Guides
56+
57+
### Git Style Guide
58+
59+
* Keep a clean, concise and meaningful git commit history on your branch, rebasing locally and squashing before submitting a PR
60+
* 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
61+
* In the subject line, use the present tense ("Add feature" not "Added feature")
62+
* In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
63+
* Limit the subject line to 72 characters or less
64+
* Reference issues and pull requests liberally after the subject line
65+
* 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`)
66+
67+
### Go Style Guide
68+
69+
* Run `gofmt` over your code to automatically resolve a lot of style issues. Most editors support this running automatically when saving a code file.
70+
* Follow this guide on some good practice and idioms for Go - https://github.com/golang/go/wiki/CodeReviewComments
71+
* To check for extra issues, install [golangci-lint](https://github.com/golangci/golangci-lint) and run `make lint` or `golangci-lint run`

0 commit comments

Comments
 (0)