Skip to content

Commit 53dac01

Browse files
asmyasnikovasmyasnikov
authored
Merge pull request #27 from ydb-platform/templates
Added templates for PR and issue. Added CI actions. Added .gitignore
2 parents 44220f7 + 10243d4 commit 53dac01

File tree

7 files changed

+214
-0
lines changed

7 files changed

+214
-0
lines changed

‎.github/ISSUE_TEMPLATE/01_BUG_REPORT.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help YDB PHP SDK to improve
4+
title: "bug: "
5+
labels: "bug"
6+
assignees: ""
7+
8+
---
9+
10+
# Bug Report
11+
12+
**YDB PHP SDK version:**
13+
14+
<!-- Please specify commit or tag version. -->
15+
16+
**Environment**
17+
18+
<!-- Please specify Operation System, CPU arcitecture -->
19+
20+
**Current behavior:**
21+
22+
<!-- Describe how the bug manifests. -->
23+
24+
**Expected behavior:**
25+
26+
<!-- Describe what the behavior would be without the bug. -->
27+
28+
**Steps to reproduce:**
29+
30+
<!-- Please explain the steps required to duplicate the issue, especially if you are able to provide a sample application. -->
31+
32+
**Related code:**
33+
34+
<!-- If you are able to illustrate the bug or feature request with an example, please provide it here. -->
35+
36+
```
37+
insert short code snippets here
38+
```
39+
40+
**Other information:**
41+
42+
<!-- List any other information that is relevant to your issue. Related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. -->

‎.github/ISSUE_TEMPLATE/02_FEATURE_REQUEST.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "feat: "
5+
labels: "enhancement"
6+
assignees: ""
7+
8+
---
9+
10+
# Feature Request
11+
12+
**Describe the Feature Request**
13+
14+
<!-- A clear and concise description of what the feature request is. Please include if your feature request is related to a problem. -->
15+
16+
**Describe Preferred Solution**
17+
18+
<!-- A clear and concise description of what you want to happen. -->
19+
20+
**Describe Alternatives**
21+
22+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
23+
24+
**Related Code**
25+
26+
<!-- If you are able to illustrate the bug or feature request with an example, please provide it here. -->
27+
28+
**Additional Context**
29+
30+
<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to add, use case, Stack Overflow links, forum links, screenshots, OS if applicable, etc. -->
31+
32+
**If the feature request is approved, would you be willing to submit a PR?**
33+
Yes / No _(Help can be provided if you need assistance submitting a PR)_

‎.github/ISSUE_TEMPLATE/03_CODEBASE_IMPROVEMENT.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: Codebase improvement
3+
about: Provide your feedback for the existing codebase. Suggest a better solution for algorithms, development tools, etc.
4+
title: "dev: "
5+
labels: "enhancement"
6+
assignees: ""
7+
8+
---

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
I hereby agree to the terms of the CLA available at: https://yandex.ru/legal/cla/?lang=en
2+
3+
<!--- Please provide a general summary of your changes in the title above -->
4+
5+
## Pull request type
6+
7+
<!-- Please try to limit your pull request to one types, submit multiple pull requests if needed. -->
8+
9+
Please check the type of change your PR introduces:
10+
11+
- [ ] Bugfix
12+
- [ ] Feature
13+
- [ ] Code style update (formatting, renaming)
14+
- [ ] Refactoring (no functional changes, no api changes)
15+
- [ ] Build related changes
16+
- [ ] Documentation content changes
17+
- [ ] Other (please describe):
18+
19+
## What is the current behavior?
20+
21+
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
22+
23+
Issue Number: N/A
24+
25+
## What is the new behavior?
26+
27+
<!-- Please describe the behavior or changes that are being added by this PR. -->
28+
29+
-
30+
-
31+
-
32+
33+
## Other information
34+
35+
<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->

‎.github/workflows/changelog.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: changelog
2+
on:
3+
pull_request_target:
4+
jobs:
5+
changelog:
6+
name: changelog
7+
concurrency:
8+
group: changelog-${{ github.ref }}
9+
cancel-in-progress: true
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout sources
13+
uses: actions/checkout@v2
14+
15+
- name: Changelog updated
16+
uses: Zomzog/changelog-checker@v1.2.0
17+
with:
18+
fileName: CHANGELOG.md
19+
env:
20+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/codeql-analysis.yml

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+
on:
15+
push:
16+
branches: [ master ]
17+
pull_request:
18+
# The branches below must be a subset of the branches above
19+
branches: [ master ]
20+
schedule:
21+
- cron: '36 3 * * 0'
22+
23+
jobs:
24+
analyze:
25+
name: Analyze
26+
concurrency:
27+
group: codeql-${{ github.ref }}
28+
cancel-in-progress: true
29+
runs-on: ubuntu-latest
30+
permissions:
31+
actions: read
32+
contents: read
33+
security-events: write
34+
35+
strategy:
36+
fail-fast: false
37+
matrix:
38+
language: [ 'go' ]
39+
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
40+
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
41+
42+
steps:
43+
- name: Checkout repository
44+
uses: actions/checkout@v3
45+
46+
# Initializes the CodeQL tools for scanning.
47+
- name: Initialize CodeQL
48+
uses: github/codeql-action/init@v2
49+
with:
50+
languages: ${{ matrix.language }}
51+
# If you wish to specify custom queries, you can do so here or in a config file.
52+
# By default, queries listed here will override any specified in a config file.
53+
# Prefix the list here with "+" to use these queries and those in the config file.
54+
55+
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
56+
# queries: security-extended,security-and-quality
57+
58+
59+
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
60+
# If this step fails, then you should remove it and run the build manually (see below)
61+
- name: Autobuild
62+
uses: github/codeql-action/autobuild@v2
63+
64+
# ℹ️ Command-line programs to run using the OS shell.
65+
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
66+
67+
# If the Autobuild fails above, remove it and uncomment the following three lines.
68+
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
69+
70+
# - run: |
71+
# echo "Run, Build Application using script"
72+
# ./location_of_script_within_repo/buildscript.sh
73+
74+
- name: Perform CodeQL Analysis
75+
uses: github/codeql-action/analyze@v2

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.idea

0 commit comments

Comments
 (0)