Skip to content

Commit 373ea34

Browse files
committed
#1: Setup project
0 parents  commit 373ea34

26 files changed

+1362
-0
lines changed

.0pdd.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
errors:
2+
3+
4+
tags:
5+
- pdd

.gitattributes

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Set the default behavior, in case people don't have core.autocrlf set.
2+
* text=auto eol=lf
3+
4+
5+
# Add readily-visible signature (in SHA format) to all files (tagged by $Id$) with extension below.
6+
# Read more https://gist.github.com/treyharris/f98b708c9f5b753d60a2 .
7+
*.java ident
8+
*.yml ident
9+
*.xml ident
10+
11+
12+
# Explicitly declare text files we want to always be normalized and converted
13+
# to native line endings on checkout.
14+
*.txt text
15+
*.java text
16+
*.groovy text
17+
*.xml text
18+
*.md text
19+
*.pom text
20+
*.properties text
21+
*.tex text
22+
*.vm text
23+
*.xsl text
24+
*.yml text
25+
26+
27+
# Denote all files that are truly binary and should not be modified.
28+
*.png binary
29+
*.jpg binary

.github/CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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 github@dgroup. 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][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Just send a pull request and call it a day.
2+
3+
4+
5+
6+
7+
Only if the build is green, you send us your pull request.
8+
9+
Thanks!

.github/ISSUE_TEMPLATE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Make sure the title of the issue explains the problem you are having. Also, the description of the issue must clearly explain what is broken, not what you want us to implement. Go through this checklist and make sure you answer "YES" to all points:
2+
3+
- You have all pre-requisites listed in README.md installed
4+
- You are sure that you are not reporting a duplicate (search all issues)
5+
- You say "is broken" or "doesn't work" in the title
6+
- You tell us what you are trying to do
7+
- You explain the results you are getting
8+
- You suggest an alternative result you would like to see
9+
10+
These articles will help you understand what we are looking for:
11+
* http://www.yegor256.com/2014/11/24/principles-of-bug-tracking.html
12+
* https://www.chiark.greenend.org.uk/~sgtatham/bugs.html
13+
14+
Thank you for your contribution!
Lines changed: 38 additions & 0 deletions
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+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
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.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Many thanks for your contribution, we truly appreciate it. We will appreciate it even more, if you make sure that you can say "YES" to each point in this short checklist:
2+
3+
- You made a small amount of changes (less than 100 lines, less than 10 files)
4+
- You made changes related to only one bug (create separate PRs for separate problems)
5+
- You are ready to defend your changes (there will be a code review)
6+
- You don't touch what you don't understand
7+
- You ran the build locally and it passed
8+
9+
This article will help you understand what we are looking for: http://www.yegor256.com/2015/02/09/serious-code-reviewer.html
10+
11+
Thank you for your contribution!

.github/workflows/build.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: CI
2+
on:
3+
push:
4+
branches:
5+
- master
6+
pull_request:
7+
types: [ opened, synchronize, reopened ]
8+
jobs:
9+
build:
10+
name: Build
11+
# @todo #/DEV Think about matrix build for linux,osx and win OS.
12+
# https://stackoverflow.com/questions/57946173/github-actions-run-step-on-specific-os
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v2
16+
with:
17+
fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
18+
# @todo #/DEV Enable Java8 for this project. For now the default config is used for JDK15.
19+
- name: Set up JDK 15
20+
uses: actions/setup-java@v1
21+
with:
22+
java-version: 15
23+
- name: Cache SonarCloud packages
24+
uses: actions/cache@v1
25+
with:
26+
path: ~/.sonar/cache
27+
key: ${{ runner.os }}-sonar
28+
restore-keys: ${{ runner.os }}-sonar
29+
- name: Cache Maven packages
30+
uses: actions/cache@v1
31+
with:
32+
path: ~/.m2
33+
key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
34+
restore-keys: ${{ runner.os }}-m2
35+
- name: Build and analyze
36+
env:
37+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
38+
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
39+
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
40+
MAVEN_OPTS: |
41+
-Xmx1024m
42+
-Dorg.slf4j.simpleLogger.dateTimeFormat=HH:mm:ss,SSS
43+
-Dorg.slf4j.simpleLogger.showDateTime=true
44+
JIRA_URL: ${{ secrets.JIRA_URL }}
45+
JIRA_USER: ${{ secrets.JIRA_USER }}
46+
JIRA_PASS: ${{ secrets.JIRA_PASS }}
47+
run: |
48+
mvn -B -P qulice clean install org.sonarsource.scanner.maven:sonar-maven-plugin:sonar
49+
bash <(curl -s https://codecov.io/bash)
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# For most projects, this workflow file will not need changing; you simply need
2+
# to commit it to your repository.
3+
#
4+
# You may wish to alter this file to override the set of languages analyzed,
5+
# or to provide custom queries or build logic.
6+
#
7+
# ******** NOTE ********
8+
# We have attempted to detect the languages in your repository. Please check
9+
# the `language` matrix defined below to confirm you have the correct set of
10+
# supported CodeQL languages.
11+
#
12+
name: "CodeQL"
13+
14+
env:
15+
java: 15
16+
17+
on:
18+
push:
19+
branches: [ master ]
20+
pull_request:
21+
# The branches below must be a subset of the branches above
22+
branches: [ master ]
23+
schedule:
24+
- cron: '20 7 * * 6'
25+
26+
jobs:
27+
analyze:
28+
name: Analyze
29+
runs-on: ubuntu-latest
30+
31+
strategy:
32+
fail-fast: false
33+
matrix:
34+
language: [ 'java' ]
35+
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
36+
# Learn more:
37+
# https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
38+
39+
steps:
40+
- name: Checkout repository
41+
uses: actions/checkout@v2
42+
43+
- name: Setup Java
44+
uses: actions/setup-java@v1
45+
with:
46+
java-version: '${{ env.java }}'
47+
48+
# Initializes the CodeQL tools for scanning.
49+
- name: Initialize CodeQL
50+
uses: github/codeql-action/init@v1
51+
with:
52+
languages: ${{ matrix.language }}
53+
# If you wish to specify custom queries, you can do so here or in a config file.
54+
# By default, queries listed here will override any specified in a config file.
55+
# Prefix the list here with "+" to use these queries and those in the config file.
56+
# queries: ./path/to/local/query, your-org/your-repo/queries@main
57+
58+
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
59+
# If this step fails, then you should remove it and run the build manually (see below)
60+
- name: Autobuild
61+
uses: github/codeql-action/autobuild@v1
62+
63+
# ℹ️ Command-line programs to run using the OS shell.
64+
# 📚 https://git.io/JvXDl
65+
66+
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
67+
# and modify them (or add more) to build your code if your project
68+
# uses a compiled language
69+
70+
#- run: |
71+
# make bootstrap
72+
# make release
73+
74+
- name: Perform CodeQL Analysis
75+
uses: github/codeql-action/analyze@v1

0 commit comments

Comments
 (0)