Skip to content

Commit 2e49c93

Browse files
committed
экшены на Node 24; community-документы
Обновлены версии GitHub Actions, чтобы убрать предупреждение о Node.js 20: actions/checkout v4→v5, actions/setup-dotnet v4→v5, softprops/action-gh-release v2→v3 (все на node24). Добавлены community-файлы: Code of Conduct, Contributing, Security policy, шаблоны issue и pull request. В README добавлен раздел Contributing со ссылками на них.
1 parent a25e001 commit 2e49c93

10 files changed

Lines changed: 355 additions & 5 deletions

File tree

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Bug report
3+
about: Report a problem to help us improve Dropwheel
4+
title: "[Bug]: "
5+
labels: ["bug"]
6+
assignees: []
7+
---
8+
9+
## Describe the bug
10+
11+
A clear and concise description of what the bug is.
12+
13+
## Steps to reproduce
14+
15+
1. Go to '...'
16+
2. Click on '...'
17+
3. Scroll down to '...'
18+
4. See error
19+
20+
## Expected behavior
21+
22+
A clear and concise description of what you expected to happen.
23+
24+
## Actual behavior
25+
26+
What actually happened. Include error messages or logs if available.
27+
28+
## Screenshots
29+
30+
If applicable, add screenshots to help explain your problem.
31+
32+
## Environment
33+
34+
- OS: [e.g. Windows 11, macOS 14]
35+
- Browser / runtime: [e.g. Chrome 126, Node 20]
36+
- Dropwheel version / commit: [e.g. v1.0.0 or commit hash]
37+
38+
## Additional context
39+
40+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security vulnerability
4+
url: https://github.com/IvanLarinDev/dropwheel/security/advisories/new
5+
about: Please report security issues privately, not as public issues.
6+
- name: Questions & discussion
7+
url: https://github.com/IvanLarinDev/dropwheel/issues
8+
about: Ask questions or discuss ideas before opening a formal issue.
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea or improvement for Dropwheel
4+
title: "[Feature]: "
5+
labels: ["enhancement"]
6+
assignees: []
7+
---
8+
9+
## Problem / motivation
10+
11+
Is your feature request related to a problem? Describe it.
12+
Example: "I'm always frustrated when [...]"
13+
14+
## Proposed solution
15+
16+
A clear and concise description of what you want to happen.
17+
18+
## Alternatives considered
19+
20+
Any alternative solutions or features you've considered.
21+
22+
## Additional context
23+
24+
Add any other context, mockups, or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Description
2+
3+
Briefly describe what this pull request changes and why.
4+
5+
## Related issue
6+
7+
Closes #<!-- issue number -->
8+
9+
## Type of change
10+
11+
- [ ] Bug fix (non-breaking change that fixes an issue)
12+
- [ ] New feature (non-breaking change that adds functionality)
13+
- [ ] Breaking change (fix or feature that changes existing behavior)
14+
- [ ] Documentation update
15+
- [ ] Refactor / chore
16+
17+
## How has this been tested?
18+
19+
Describe the tests you ran and how to reproduce them.
20+
21+
## Checklist
22+
23+
- [ ] My code follows the project's style and conventions
24+
- [ ] I have performed a self-review of my changes
25+
- [ ] I have commented my code where necessary
26+
- [ ] I have updated documentation where needed
27+
- [ ] My changes generate no new warnings or errors
28+
- [ ] I have read the [Contributing guidelines](../CONTRIBUTING.md)

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ jobs:
99
build:
1010
runs-on: windows-latest
1111
steps:
12-
- uses: actions/checkout@v4
12+
- uses: actions/checkout@v5
1313

14-
- uses: actions/setup-dotnet@v4
14+
- uses: actions/setup-dotnet@v5
1515
with:
1616
dotnet-version: 10.0.x
1717

.github/workflows/release.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ jobs:
1212
release:
1313
runs-on: windows-latest
1414
steps:
15-
- uses: actions/checkout@v4
15+
- uses: actions/checkout@v5
1616

17-
- uses: actions/setup-dotnet@v4
17+
- uses: actions/setup-dotnet@v5
1818
with:
1919
dotnet-version: 10.0.x
2020

@@ -33,7 +33,7 @@ jobs:
3333
Compress-Archive -Path dist-sc/* -DestinationPath "Dropwheel-${{ github.ref_name }}-win-x64-self-contained.zip"
3434
3535
- name: Create GitHub Release
36-
uses: softprops/action-gh-release@v2
36+
uses: softprops/action-gh-release@v3
3737
with:
3838
files: Dropwheel-*.zip
3939
generate_release_notes: true

CODE_OF_CONDUCT.md

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official email address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement by opening a
63+
[GitHub issue](https://github.com/IvanLarinDev/dropwheel/issues) or, for
64+
sensitive matters, through a
65+
[private security advisory](https://github.com/IvanLarinDev/dropwheel/security/advisories/new).
66+
All complaints will be reviewed and investigated promptly and fairly.
67+
68+
All community leaders are obligated to respect the privacy and security of the
69+
reporter of any incident.
70+
71+
## Enforcement Guidelines
72+
73+
Community leaders will follow these Community Impact Guidelines in determining
74+
the consequences for any action they deem in violation of this Code of Conduct:
75+
76+
### 1. Correction
77+
78+
**Community Impact**: Use of inappropriate language or other behavior deemed
79+
unprofessional or unwelcome in the community.
80+
81+
**Consequence**: A private, written warning from community leaders, providing
82+
clarity around the nature of the violation and an explanation of why the
83+
behavior was inappropriate. A public apology may be requested.
84+
85+
### 2. Warning
86+
87+
**Community Impact**: A violation through a single incident or series of
88+
actions.
89+
90+
**Consequence**: A warning with consequences for continued behavior. No
91+
interaction with the people involved, including unsolicited interaction with
92+
those enforcing the Code of Conduct, for a specified period of time. This
93+
includes avoiding interactions in community spaces as well as external channels
94+
like social media. Violating these terms may lead to a temporary or permanent
95+
ban.
96+
97+
### 3. Temporary Ban
98+
99+
**Community Impact**: A serious violation of community standards, including
100+
sustained inappropriate behavior.
101+
102+
**Consequence**: A temporary ban from any sort of interaction or public
103+
communication with the community for a specified period of time. No public or
104+
private interaction with the people involved, including unsolicited interaction
105+
with those enforcing the Code of Conduct, is allowed during this period.
106+
Violating these terms may lead to a permanent ban.
107+
108+
### 4. Permanent Ban
109+
110+
**Community Impact**: Demonstrating a pattern of violation of community
111+
standards, including sustained inappropriate behavior, harassment of an
112+
individual, or aggression toward or disparagement of classes of individuals.
113+
114+
**Consequence**: A permanent ban from any sort of public interaction within the
115+
community.
116+
117+
## Attribution
118+
119+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
120+
version 2.1, available at
121+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
122+
123+
Community Impact Guidelines were inspired by
124+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
128+
[https://www.contributor-covenant.org/translations][translations].
129+
130+
[homepage]: https://www.contributor-covenant.org
131+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
132+
[Mozilla CoC]: https://github.com/mozilla/diversity
133+
[FAQ]: https://www.contributor-covenant.org/faq
134+
[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Contributing to Dropwheel
2+
3+
Thanks for your interest in contributing to Dropwheel! This document explains how
4+
to propose changes so they can be reviewed and merged smoothly.
5+
6+
By participating in this project you agree to abide by our
7+
[Code of Conduct](CODE_OF_CONDUCT.md).
8+
9+
## Ways to contribute
10+
11+
- **Report a bug** — open a [bug report](https://github.com/IvanLarinDev/dropwheel/issues/new/choose).
12+
- **Request a feature** — open a [feature request](https://github.com/IvanLarinDev/dropwheel/issues/new/choose).
13+
- **Improve docs** — fixes to the README or other documentation are always welcome.
14+
- **Submit code** — pick up an open issue or propose a change via a pull request.
15+
16+
## Before you start
17+
18+
For anything larger than a small fix, please open an issue first to discuss the
19+
approach. This avoids duplicate work and makes review faster.
20+
21+
## Development workflow
22+
23+
1. **Fork** the repository and clone your fork.
24+
2. **Create a branch** from `main` with a descriptive name, e.g.
25+
`feature/smart-routing` or `fix/shelf-overflow`.
26+
3. **Make your changes** in focused, logically separated commits.
27+
4. **Test** your changes locally and make sure existing behavior still works.
28+
5. **Push** the branch to your fork.
29+
6. **Open a pull request** against `main` and fill in the PR template.
30+
31+
## Commit messages
32+
33+
Write clear, imperative commit messages, for example:
34+
35+
```
36+
Add smart routing fallback for empty shelf
37+
Fix off-by-one in wheel index calculation
38+
```
39+
40+
Reference related issues where relevant (e.g. `Fixes #123`).
41+
42+
## Pull request guidelines
43+
44+
- Keep pull requests focused; one logical change per PR is easier to review.
45+
- Fill out the pull request template completely.
46+
- Link the issue your PR addresses.
47+
- Describe what you changed and how you verified it.
48+
- Be responsive to review feedback.
49+
50+
## Reporting security issues
51+
52+
Please do **not** report security vulnerabilities through public issues. See our
53+
[Security Policy](SECURITY.md) for how to report them privately.
54+
55+
## Questions
56+
57+
If anything is unclear, open a
58+
[GitHub Discussion or issue](https://github.com/IvanLarinDev/dropwheel/issues)
59+
and we'll help you get started.
60+
61+
Thank you for helping make Dropwheel better!

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,13 @@ are tuned per theme.
137137
copied; files renamed by the conflict dialog are not tracked by Undo.
138138
- One orb (multi-monitor placement works; one wheel instance).
139139

140+
## Contributing
141+
142+
Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for how to
143+
propose changes, [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for community
144+
expectations, and [SECURITY.md](SECURITY.md) for reporting vulnerabilities
145+
privately. Bug reports and feature requests use the issue templates.
146+
140147
## License
141148

142149
[MIT](LICENSE) © Ivan Larin

SECURITY.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Security Policy
2+
3+
We take the security of Dropwheel seriously. Thank you for helping keep the
4+
project and its users safe.
5+
6+
## Supported versions
7+
8+
Dropwheel is under active development. Security fixes are applied to the latest
9+
release and the `main` branch. Older versions may not receive fixes.
10+
11+
| Version | Supported |
12+
| ------- | ------------------ |
13+
| latest | :white_check_mark: |
14+
| older | :x: |
15+
16+
## Reporting a vulnerability
17+
18+
**Please do not report security vulnerabilities through public GitHub issues,
19+
discussions, or pull requests.**
20+
21+
Instead, report them privately using GitHub's private vulnerability reporting:
22+
23+
1. Go to the [Security advisories page](https://github.com/IvanLarinDev/dropwheel/security/advisories/new).
24+
2. Click **Report a vulnerability**.
25+
3. Provide as much detail as you can (see below).
26+
27+
If private reporting is unavailable, please open a minimal placeholder issue
28+
asking a maintainer to contact you, without disclosing any vulnerability
29+
details.
30+
31+
## What to include
32+
33+
To help us triage quickly, please include:
34+
35+
- A description of the vulnerability and its potential impact.
36+
- Steps to reproduce, or a proof of concept.
37+
- The affected version, component, or file.
38+
- Any suggested mitigation, if known.
39+
40+
## What to expect
41+
42+
- We aim to acknowledge your report within a few business days.
43+
- We will investigate and keep you informed of progress.
44+
- Once a fix is available, we will coordinate disclosure and credit you if you
45+
wish.
46+
47+
We ask that you give us a reasonable amount of time to address the issue before
48+
any public disclosure. Thank you for practicing responsible disclosure.

0 commit comments

Comments
 (0)