Skip to content

Commit 9e26578

Browse files
author
Sergei Orlov
committed
📝 Add github stuff
1 parent d85ca76 commit 9e26578

14 files changed

+365
-0
lines changed

.github/code_of_conduct.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
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, gender identity and expression, level of experience,
9+
education, socio-economic status, nationality, personal appearance, race,
10+
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 project team at orlove.dev@gmail.com. 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 [here][code-of-conduct].
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
[code-of-conduct]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

.github/codeowners

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

.github/contributing.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other
4+
method with the owners of this repository before making a change.
5+
6+
Please note we have a code of conduct, please follow it in all your interactions with the project.
7+
8+
## Pull Request Process
9+
10+
- Create a fork for the repository
11+
- Add\update dependencies only after receiving approval from the owners of the repository
12+
- Do not manually change project version in `package.json`
13+
- Contributed code must be at least 80% covered with tests
14+
- Contributed code must be checked with linting tools set up for the project
15+
- Create a pull request to `main` branch of current repository
16+
- Specify link to the issue you are resolving with this contribution (if applicable)
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: orlovedev
7+
---
8+
9+
## Describe the bug
10+
11+
<!-- A clear and concise description of what the bug is -->
12+
13+
## To Reproduce
14+
15+
<!-- Steps to reproduce the behavior -->
16+
17+
## Expected behavior
18+
19+
<!-- A clear and concise description of what you expected to happen -->
20+
21+
## Screenshots
22+
23+
<!-- If applicable, add screenshots to help explain your problem -->
24+
25+
## Additional context
26+
27+
<!-- Add any other context about the problem here -->
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[ENHANCEMENT] '
5+
labels: enhancement
6+
assignees: orlovedev
7+
---
8+
9+
## Is your feature request related to a problem? Please describe
10+
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+
15+
<!-- A clear and concise description of what you want to happen -->
16+
17+
## Describe alternatives you've considered
18+
19+
<!-- A clear and concise description of any alternative solutions or features you've considered -->
20+
21+
## Additional context
22+
23+
<!-- Add any other context or screenshots about the feature request here -->

.github/pull_request_template.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Description
2+
3+
<!-- Describe your changes in detail -->
4+
5+
## Motivation and Context
6+
7+
<!-- Why is this change required? What problem does it solve? -->
8+
9+
<!-- If it fixes an open issue, please link to the issue here. -->
10+
11+
## Screenshots
12+
13+
<!-- If appropriate -->
14+
15+
## Types of changes
16+
17+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
18+
19+
- [ ] Bug fix (non-breaking change which fixes an issue)
20+
- [ ] Security fix (non-breaking change wich fixes a security issue)
21+
- [ ] New feature (non-breaking change which adds functionality)
22+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as
23+
expected)

.github/security.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
| ------- | ------------------ |
7+
| >=1.0.0 | :white_check_mark: |
8+
9+
## Reporting a Vulnerability
10+
11+
In order to report vulnerability, create an issue using `Bug` template.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Codecov Reports
2+
on: [push]
3+
jobs:
4+
run:
5+
runs-on: ${{ matrix.os }}
6+
strategy:
7+
matrix:
8+
os: [ubuntu-latest, macos-latest, windows-latest]
9+
env:
10+
OS: ${{ matrix.os }}
11+
NODE: '12.x'
12+
steps:
13+
- uses: actions/checkout@master
14+
- name: Setup Node
15+
uses: actions/setup-node@v1
16+
with:
17+
node-version: '12.x'
18+
- name: Install dependencies
19+
run: yarn
20+
- name: Generate coverage report
21+
run: yarn test:cover
22+
- name: Upload coverage to Codecov
23+
uses: codecov/codecov-action@v1
24+
with:
25+
flags: unittests
26+
env_vars: OS,NODE
27+
name: codecov-umbrella
28+
fail_ci_if_error: true
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: XO
2+
on: [push, pull_request]
3+
jobs:
4+
check:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- uses: actions/checkout@v2
8+
- name: Setup Node
9+
uses: actions/setup-node@v1
10+
with:
11+
node-version: '12.x'
12+
- name: Install dependencies
13+
run: yarn
14+
- name: Lint
15+
run: yarn lint
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Publish Package (Alpha)
2+
on:
3+
release:
4+
types: [prereleased]
5+
jobs:
6+
npm:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v2
10+
- uses: actions/setup-node@v1
11+
with:
12+
node-version: "12.x"
13+
registry-url: "https://registry.npmjs.org"
14+
- name: Set env
15+
run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
16+
- name: Install dependencies
17+
run: yarn
18+
- name: Transpile to JavaScript
19+
run: yarn build
20+
- run: |
21+
sed -i s/"\"version\":.*/\"version\": \"$RELEASE_VERSION\","/ package.json
22+
- name: Publish to NPM
23+
run: npm publish
24+
env:
25+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
26+
ghp:
27+
runs-on: ubuntu-latest
28+
steps:
29+
- uses: actions/checkout@v2
30+
- uses: actions/setup-node@v1
31+
with:
32+
node-version: "12.x"
33+
registry-url: "https://npm.pkg.github.com"
34+
- name: Set env
35+
run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
36+
- name: Install dependencies
37+
run: yarn
38+
- name: Transpile to JavaScript
39+
run: yarn build
40+
- run: |
41+
sed -i s/"\"version\":.*/\"version\": \"$RELEASE_VERSION\","/ package.json
42+
- name: Publish to GHP
43+
run: npm publish --access=public
44+
env:
45+
NODE_AUTH_TOKEN: ${{ secrets.OR_RELEASE_TOKEN }}

0 commit comments

Comments
 (0)