Skip to content

Commit ee09bf6

Browse files
author
Peter Kelly
authored
Release preparation including some renaming and some additional files (#6)
* Prepare project for release as open-source - Some file renaming - Addition of open source documentation - Improve README and Makefile * Add note about support * Add compatibility note. Fix formatting
1 parent 75018e7 commit ee09bf6

File tree

10 files changed

+430
-22
lines changed

10 files changed

+430
-22
lines changed

‎.github/ISSUE_TEMPLATE/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-plus-go-sdk/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

‎.github/ISSUE_TEMPLATE/bug_report.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
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+
12+
Steps to reproduce the behavior, such as:
13+
1. Try adding upstream through the client
14+
2. Returns a panic
15+
3. Here is the stacktrace
16+
17+
**Expected behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Your environment**
21+
* Version of nginx-plus-go-sdk
22+
* Version of NGINX Plus
23+
* Version of the OS
24+
25+
**Additional context**
26+
Add any other context about the problem here.

‎.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 about the feature request here.

‎CHANGELOG.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## 0.1 (July 30, 2018)
2+
3+
Initial release

‎CONTRIBUTING.md

+138
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
# Contributing Guidelines
2+
3+
The following is a set of guidelines for contributing to the NGINX Plus Go SDK. 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](#code-of-conduct)
18+
19+
## Ask a Question
20+
21+
We will have a public forum soon where you can come and ask questions and have a discussion. For now please open an Issue on GitHub with the label `question`.
22+
23+
24+
## Getting Started
25+
26+
Read the usage and testing steps in the [README](README.md).
27+
28+
29+
## Contributing
30+
31+
### Report a Bug
32+
33+
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.
34+
35+
### Suggest an Enhancement
36+
37+
To suggest an enhancement, please create an issue on GitHub with the label `enhancement` using the available feature issue template.
38+
39+
### Open a Pull Request
40+
41+
* Fork the repo, create a branch, submit a PR when your changes are tested and ready for review
42+
* You will be asked to fill in [our pull request template](.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md)
43+
44+
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.
45+
46+
## Style Guides
47+
48+
### Git Style Guide
49+
50+
* Keep a clean, concise and meaningful git commit history on your branch, rebasing locally and squashing before submitting a PR
51+
* 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
52+
* In the subject line, use the present tense ("Add feature" not "Added feature")
53+
* In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
54+
* Limit the subject line to 72 characters or less
55+
* Reference issues and pull requests liberally after the subject line
56+
* 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`)
57+
58+
### Go Style Guide
59+
60+
* Run `gofmt` over your code to automatically resolve a lot of style issues. Most editors support this running automatically when saving a code file.
61+
* Run `go lint` and `go vet` on your code too to catch any other issues.
62+
* Follow this guide on some good practice and idioms for Go - https://github.com/golang/go/wiki/CodeReviewComments
63+
64+
## Code of Conduct
65+
66+
This project and everyone participating in it is governed by this code.
67+
68+
### Our Pledge
69+
70+
In the interest of fostering an open and welcoming environment, we as
71+
contributors and maintainers pledge to making participation in our project and
72+
our community a harassment-free experience for everyone, regardless of age, body
73+
size, disability, ethnicity, sex characteristics, gender identity and expression,
74+
level of experience, education, socio-economic status, nationality, personal
75+
appearance, race, religion, or sexual identity and orientation.
76+
77+
### Our Standards
78+
79+
Examples of behavior that contributes to creating a positive environment
80+
include:
81+
82+
* Using welcoming and inclusive language
83+
* Being respectful of differing viewpoints and experiences
84+
* Gracefully accepting constructive criticism
85+
* Focusing on what is best for the community
86+
* Showing empathy towards other community members
87+
88+
Examples of unacceptable behavior by participants include:
89+
90+
* The use of sexualized language or imagery and unwelcome sexual attention or
91+
advances
92+
* Trolling, insulting/derogatory comments, and personal or political attacks
93+
* Public or private harassment
94+
* Publishing others' private information, such as a physical or electronic
95+
address, without explicit permission
96+
* Other conduct which could reasonably be considered inappropriate in a
97+
professional setting
98+
99+
### Our Responsibilities
100+
101+
Project maintainers are responsible for clarifying the standards of acceptable
102+
behavior and are expected to take appropriate and fair corrective action in
103+
response to any instances of unacceptable behavior.
104+
105+
Project maintainers have the right and responsibility to remove, edit, or
106+
reject comments, commits, code, wiki edits, issues, and other contributions
107+
that are not aligned to this Code of Conduct, or to ban temporarily or
108+
permanently any contributor for other behaviors that they deem inappropriate,
109+
threatening, offensive, or harmful.
110+
111+
### Scope
112+
113+
This Code of Conduct applies both within project spaces and in public spaces
114+
when an individual is representing the project or its community. Examples of
115+
representing a project or community include using an official project e-mail
116+
address, posting via an official social media account, or acting as an appointed
117+
representative at an online or offline event. Representation of a project may be
118+
further defined and clarified by project maintainers.
119+
120+
### Enforcement
121+
122+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
123+
reported by contacting the project team at [mailto:[email protected]]. All
124+
complaints will be reviewed and investigated and will result in a response that
125+
is deemed necessary and appropriate to the circumstances. The project team is
126+
obligated to maintain confidentiality with regard to the reporter of an incident.
127+
Further details of specific enforcement policies may be posted separately.
128+
129+
Project maintainers who do not follow or enforce the Code of Conduct in good
130+
faith may face temporary or permanent repercussions as determined by other
131+
members of the project's leadership.
132+
133+
### Attribution
134+
135+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
136+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
137+
138+
[homepage]: https://www.contributor-covenant.org

0 commit comments

Comments
 (0)