Skip to content

Commit c0f6515

Browse files
authored
Merge pull request #2 from Senzing/issue-1.dockter.1
#1 Added Community artifacts
2 parents 45709cd + 4cb7940 commit c0f6515

32 files changed

+1285
-0
lines changed

Diff for: .dockerignore

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.github/
2+
docs/
3+
.DS_Store
4+
.gitignore
5+
.project
6+
.pydevproject
7+
CHANGELOG.md
8+
CODE_OF_CONDUCT.md
9+
CONTRIBUTING.md
10+
docker-compose.test.yml
11+
LICENSE
12+
Makefile
13+
PULL_REQUEST_TEMPLATE.md
14+
README.md

Diff for: .github/CODEOWNERS

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

Diff for: .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.

Diff for: .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.

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/dependabot.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Please see the documentation for all configuration options:
2+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
3+
4+
version: 2
5+
updates:
6+
- package-ecosystem: "github-actions"
7+
directory: "/"
8+
schedule:
9+
interval: "daily"
10+
- package-ecosystem: "docker"
11+
directory: "/"
12+
schedule:
13+
interval: "daily"
14+
- package-ecosystem: "pip"
15+
directory: "/"
16+
schedule:
17+
interval: "daily"
58.4 KB
Binary file not shown.
68.4 KB
Binary file not shown.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Based on
2+
# - https://github.com/srggrs/assign-one-project-github-action
3+
4+
name: add-dependabot-request-to-project-t-comm.yaml
5+
on:
6+
pull_request:
7+
types:
8+
- opened
9+
- reopened
10+
env:
11+
GITHUB_TOKEN: ${{ secrets.SENZING_GITHUB_ACCESS_TOKEN }}
12+
CREATOR: ${{ github.event.pull_request.user.login }}
13+
jobs:
14+
assign_one_project:
15+
name: Add dependabot pull request to Senzing Community project
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Assign pull request to project
19+
env:
20+
BOOL: ${{ contains( env.CREATOR, 'dependabot' ) }}
21+
uses: Senzing/github-action-add-issue-to-project@main
22+
if: ${{ env.BOOL == 'true' }}
23+
with:
24+
project: 'https://github.com/orgs/Senzing/projects/2'

Diff for: .github/workflows/add-issue-to-project-t-comm.yaml

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

Diff for: .github/workflows/add-triage-label.yaml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Based on
2+
# - https://docs.github.com/en/actions/guides/adding-labels-to-issues
3+
# - https://github.com/andymckay/labeler
4+
5+
name: add-triage-label.yaml
6+
on:
7+
issues:
8+
types:
9+
- reopened
10+
- opened
11+
jobs:
12+
automate-issues-labels:
13+
name: Add triage label to issue
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: initial labeling
17+
uses: andymckay/[email protected]
18+
with:
19+
add-labels: "triage"

Diff for: .github/workflows/identify-customer.yaml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: identify-customer.yaml
2+
on:
3+
issues:
4+
types:
5+
- opened
6+
env:
7+
GITHUB_TOKEN: ${{ secrets.ORG_MEMBERSHIP_TOKEN }}
8+
MEMBER_LIST: ${{ secrets.SENZING_MEMBERS }}
9+
CREATOR: ${{ github.actor }}
10+
jobs:
11+
automate-issues-labels:
12+
name: Add customer-submission label
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: initial labeling
16+
env:
17+
BOOL: ${{ contains( env.MEMBER_LIST, env.CREATOR ) }}
18+
if: ${{ env.BOOL == 'false' }}
19+
uses: andymckay/[email protected]
20+
with:
21+
add-labels: "customer-submission"

Diff for: .github/workflows/pylint.yaml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: pylint.yaml
2+
3+
on: [push]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
strategy:
9+
matrix:
10+
python-version: ["3.8", "3.9", "3.10"]
11+
steps:
12+
- uses: actions/checkout@v3
13+
- name: Set up Python ${{ matrix.python-version }}
14+
uses: actions/setup-python@v4
15+
with:
16+
python-version: ${{ matrix.python-version }}
17+
- name: Install dependencies
18+
run: |
19+
python -m pip install --upgrade pip
20+
pip install pylint
21+
- name: Analysing the code with pylint
22+
run: |
23+
pylint $(git ls-files '*.py')

Diff for: .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>code-snippets</name>
4+
</projectDescription>

Diff for: .pylintrc

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
[pylint]
2+
disable=
3+
broad-except,
4+
consider-using-f-string,
5+
line-too-long,
6+
too-many-branches,
7+
too-many-locals,
8+
good-names=
9+
template-python
10+
ignore=
11+
__init__.py,
12+
notes=
13+
FIXME,

Diff for: 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

Diff for: 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/

0 commit comments

Comments
 (0)