Skip to content

Commit 599bef3

Browse files
docktermjdocktermj
committed
#1 Community artifacts
1 parent 61ec081 commit 599bef3

17 files changed

+391
-0
lines changed

‎.github/CODEOWNERS

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Default code owner
2+
3+
* @Senzing/senzing-engineering

‎.github/ISSUE_TEMPLATE/bug_report.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
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+
13+
1. Go to '...'
14+
2. Click on '....'
15+
3. Scroll down to '....'
16+
4. See error
17+
18+
**Expected behavior**
19+
A clear and concise description of what you expected to happen.
20+
21+
**Screenshots**
22+
If applicable, add screenshots to help explain your problem.
23+
24+
**Desktop (please complete the following information):**
25+
26+
- OS: [e.g. iOS]
27+
- Browser [e.g. chrome, safari]
28+
- Version [e.g. 22]
29+
30+
**Smartphone (please complete the following information):**
31+
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/documentation_request.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Documentation request
3+
about: Identify an area for improvement in documentation
4+
5+
---
6+
7+
**What is the URL of the documentation?**
8+
9+
- **Example:** https://github.com/Senzing/template-docker#external-database
10+
- *Note:* This URL includes the web page and the section of the documentation.
11+
12+
**What can be improved?**
13+
14+
A clear and concise description of what can be improved.
15+
Examples:
16+
17+
- "I don't understand where the ${XYZ} variable is set."
18+
- "There seems to be a step missing between 'X' and 'Z'. I don't know how to get to 'Z'."
19+
- "When I run `command sub-command ...` I get the following error:"
20+
- "I don't know what is meant by 'gerble barb gazoink` in the instructions".
21+
22+
**Additional context**
23+
24+
Add any other context or screenshots to help describe the documentation improvement.
25+
If you think the documentation improvement is operating system specific,
26+
please indicate which operating system is being used.

‎.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.

‎.github/senzing-corporate-contributor-license-agreement.pdf

58.4 KB
Binary file not shown.

‎.github/senzing-individual-contributor-license-agreement.pdf

68.4 KB
Binary file not shown.

‎.github/workflows/add-to-project-t-gdev.yaml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Based on
2+
# - https://github.com/srggrs/assign-one-project-github-action
3+
4+
name: Auto Assign issue to project
5+
6+
on:
7+
issues:
8+
types:
9+
- reopened
10+
- opened
11+
env:
12+
GITHUB_TOKEN: ${{ secrets.SENZING_GITHUB_ACCESS_TOKEN }}
13+
14+
jobs:
15+
assign_one_project:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Assign issues to project
19+
uses: Senzing/github-action-add-issue-to-project@main
20+
with:
21+
project: 'https://github.com/orgs/Senzing/projects/9'
22+
column_name: 'Backlog'

‎.github/workflows/add-triage-label.yaml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Based on
2+
# - https://docs.github.com/en/actions/guides/adding-labels-to-issues
3+
# - https://github.com/andymckay/labeler
4+
5+
# This workflow uses actions that are not certified by GitHub.
6+
# They are provided by a third-party and are governed by
7+
# separate terms of service, privacy policy, and support
8+
# documentation.
9+
10+
name: Simple Issue Labeler
11+
on:
12+
issues:
13+
types:
14+
- reopened
15+
- opened
16+
jobs:
17+
automate-issues-labels:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- name: initial labeling
21+
uses: andymckay/[email protected]
22+
with:
23+
add-labels: "triage"

‎.github/workflows/identify-customer.yaml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: identify_customer
2+
3+
on:
4+
issues:
5+
types:
6+
- opened
7+
env:
8+
GITHUB_TOKEN: ${{ secrets.ORG_MEMBERSHIP_TOKEN }}
9+
MEMBER_LIST: ${{ secrets.SENZING_MEMBERS }}
10+
CREATOR: ${{ github.actor }}
11+
TITLE: ${{ github.event.issue.title }}
12+
NUMBER: ${{ github.event.issue.number }}
13+
TOKEN: ${{ secrets.SENZING_SLACK_BEARER_TOKEN }}
14+
REPO_URL: ${{ github.repository }}
15+
SLACK_HASHES: ${{ secrets.SENZING_GITHUB_SLACK_MAP }}
16+
17+
jobs:
18+
check-membership:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: run script
22+
env:
23+
BOOL: ${{ contains( env.MEMBER_LIST, env.CREATOR ) }}
24+
if: ${{ env.BOOL == 'false' }}
25+
uses: Senzing/github-action-identify-customer@main
26+
automate-issues-labels:
27+
runs-on: ubuntu-latest
28+
steps:
29+
- name: initial labeling
30+
env:
31+
BOOL: ${{ contains( env.MEMBER_LIST, env.CREATOR ) }}
32+
if: ${{ env.BOOL == 'false' }}
33+
uses: andymckay/[email protected]
34+
with:
35+
add-labels: "customer-submission"

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.DS_Store
2+
.history

‎.project

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>postgresql-performance</name>
4+
</projectDescription>

‎CHANGELOG.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
[markdownlint](https://dlaa.me/markdownlint/),
7+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
8+
9+
## [Unreleased]
10+
11+
- Thing 5
12+
- Thing 4
13+
14+
## [1.0.1] - yyyy-mm-dd
15+
16+
### Added to 1.0.1
17+
18+
- Thing 3
19+
20+
### Fixed in 1.0.1
21+
22+
- Thing 2
23+
24+
## [1.0.0] - yyyy-mm-dd
25+
26+
### Added to 1.0.0
27+
28+
- Thing 2
29+
- Thing 1

‎CODE_OF_CONDUCT.md

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

‎CONTRIBUTING.md

+124
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# Contributing
2+
3+
Welcome to the project!
4+
5+
We encourage contribution in a manner consistent with the [Code of Conduct](CODE_OF_CONDUCT.md).
6+
The following will guide you through the process.
7+
8+
There are a number of ways you can contribute:
9+
10+
1. [Asking questions](#questions)
11+
1. [Requesting features](#feature-requests)
12+
1. [Reporting bugs](#bug-reporting)
13+
1. [Contributing code or documentation](#contributing-code-or-documentation)
14+
15+
## License Agreements
16+
17+
If your contribution modifies the git repository, the following agreements must be established.
18+
19+
*Note:* License agreements are only needed for adding, modifying, and deleting artifacts kept within the repository.
20+
In simple terms, license agreements are needed before pull requests can be accepted.
21+
A license agreement is not needed for submitting feature request, bug reporting, or other project management.
22+
23+
### Individual Contributor License Agreement
24+
25+
In order to contribute to this repository, an
26+
[Individual Contributor License Agreement (ICLA)](.github/senzing-individual-contributor-license-agreement.pdf)
27+
must be completed, submitted and accepted.
28+
29+
### Corporate Contributor License Agreement
30+
31+
If the contribution to this repository is on behalf of a company, a
32+
[Corporate Contributor License Agreement (CCLA)](.github/senzing-corporate-contributor-license-agreement.pdf)
33+
must also be completed, submitted and accepted.
34+
35+
### Project License Agreement
36+
37+
The license agreement for this repository is stated in the
38+
[LICENSE](LICENSE) file.
39+
40+
## Questions
41+
42+
Please do not use the GitHub issue tracker to submit questions.
43+
44+
TODO: Instead, use ???
45+
46+
1. ??? Slack ???
47+
1. ??? stackoverflow.com ???
48+
49+
## Feature Requests
50+
51+
All feature requests are "GitHub issues".
52+
To request a feature, create a
53+
[GitHub issue](https://help.github.com/articles/creating-an-issue/)
54+
in this repository.
55+
56+
When creating an issue, there will be a choice to create a "Bug report" or a "Feature request".
57+
Choose "Feature request".
58+
59+
## Bug Reporting
60+
61+
All bug reports are "GitHub issues".
62+
Before reporting on a bug, check to see if it has
63+
[already been reported](https://github.com/search?q=+is%3Aissue+user%3Asenzing).
64+
To report a bug, create a
65+
[GitHub issue](https://help.github.com/articles/creating-an-issue/)
66+
in this repository.
67+
68+
When creating an issue, there will be a choice to create a "Bug report" or a "Feature request".
69+
Choose "Bug report".
70+
71+
## Contributing code or documentation
72+
73+
To contribute code or documentation to the repository, you must have
74+
[License Agreements](#license-agreements) in place.
75+
This needs to be complete before a [Pull Request](#pull-requests) can be accepted.
76+
77+
### Setting up a development environment
78+
79+
#### Set Environment variables
80+
81+
These variables may be modified, but do not need to be modified.
82+
The variables are used throughout the installation procedure.
83+
84+
```console
85+
export GIT_ACCOUNT=senzing
86+
export GIT_REPOSITORY=postgresql-performance
87+
```
88+
89+
Synthesize environment variables.
90+
91+
```console
92+
export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git
93+
export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}"
94+
export GIT_REPOSITORY_URL="[email protected]:${GIT_ACCOUNT}/${GIT_REPOSITORY}.git"
95+
```
96+
97+
#### Clone repository
98+
99+
Get repository.
100+
101+
```console
102+
mkdir --parents ${GIT_ACCOUNT_DIR}
103+
cd ${GIT_ACCOUNT_DIR}
104+
git clone ${GIT_REPOSITORY_URL}
105+
cd ${GIT_REPOSITORY_DIR}
106+
```
107+
108+
### Coding conventions
109+
110+
TODO:
111+
112+
### Testing
113+
114+
TODO:
115+
116+
### Pull Requests
117+
118+
Code in the master branch is modified via GitHub pull request.
119+
Follow GitHub's
120+
[Creating a pull request from a branch](https://help.github.com/articles/creating-a-pull-request/)
121+
or
122+
[Creating a pull request from a fork](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) instructions.
123+
124+
Accepting pull requests will be at the discretion of Senzing, Inc. and the repository owner(s).

‎PULL_REQUEST_TEMPLATE.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Pull request questions
2+
3+
## Which issue does this address
4+
5+
Issue number: #nnn
6+
7+
## Why was change needed
8+
9+
???
10+
11+
## What does change improve
12+
13+
???

0 commit comments

Comments
 (0)