Skip to content

Commit 4738e4a

Browse files
velerveler
committed
added policies
1 parent b04aed1 commit 4738e4a

File tree

7 files changed

+267
-2
lines changed

7 files changed

+267
-2
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Bug Report
2+
description: Report a bug encountered while using CtrlHelp
3+
labels: bug, untriaged
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
If you encounter this problem too, leave a thumbs up 👍
9+
10+
- type: textarea
11+
id: current-behavior
12+
attributes:
13+
label: Current behavior
14+
description: A clear and concise description of what the bug is.
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: how-to-reproduce
20+
attributes:
21+
label: How to reproduce it (as minimally and precisely as possible)
22+
description: Steps to reproduce the behavior.
23+
placeholder: |
24+
Please provide a **MINIMAL REPRO PROJECT** and the **STEPS TO REPRODUCE**
25+
1. Go to '....'
26+
2. Click on '....'
27+
3. Scroll down to '....'
28+
4. See the error
29+
validations:
30+
required: false
31+
32+
- type: textarea
33+
id: expected-behavior
34+
attributes:
35+
label: Expected behavior
36+
description: A clear and concise description of what you expected to happen.
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
attributes:
42+
label: Screenshots
43+
description: If applicable, add screenshots here to help explain your problem
44+
45+
- type: textarea
46+
id: workaround
47+
attributes:
48+
label: Workaround
49+
description: Please provide steps to workaround this problem if possible
50+
51+
- type: input
52+
id: ctrlhelp-version
53+
attributes:
54+
label: CtrlHelp Version
55+
description: Which version of CtrlHelp are you using? The version number can be found by going to CtrlHelp' Settings > About
56+
placeholder: "e.g. Version: 1.0.0.0 | X64"
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
attributes:
62+
label: Relevant Assets/Logs
63+
description: |
64+
A list of assets (logs, screenshots, etc) relevant to this bug.
65+
66+
Tip: You can attach image(s) or log file(s) by clicking this area to highlight it and then dragging files in.
67+
placeholder: |
68+
To upload the log, access it from Settings -> About -> Open log location.

‎.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Questions
4+
url: https://github.com/veler/CtrlHelp/discussions
5+
about: 'For general questions about CtrlHelp, visit GitHub discussions'

‎.github/ISSUE_TEMPLATE/enhancement_request.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Enhancement Request
2+
description: Suggest an idea to improve an existing feature in CtrlHelp
3+
labels: enhancement, untriaged
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
If you find this request relevant to you too, leave a thumbs up 👍
9+
10+
- type: textarea
11+
attributes:
12+
label: What improvement do you think would an existing feature in CtrlHelp?
13+
description: Please include your use case.
14+
validations:
15+
required: true
16+
17+
- type: textarea
18+
attributes:
19+
label: Solution/Idea
20+
description: Describe your solution/idea. If possible, provide mock-up or example of how your idea could look like.
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
attributes:
26+
label: Comments
27+
description: Additional information, comments or screenshots about the feature request.

‎.github/ISSUE_TEMPLATE/feature_request.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Feature Request
2+
description: Suggest an idea for a new feature or app's keyboard shortcut to support in CtrlHelp
3+
labels: feature, untriaged
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
If you find this request relevant to you too, leave a thumbs up 👍
9+
10+
- type: textarea
11+
attributes:
12+
label: What feature or new app's keyboard shortcut do you think should be added to CtrlHelp?
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
attributes:
18+
label: Why do you think this is needed?
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
attributes:
24+
label: Solution/Idea
25+
description: Describe your solution/idea. If possible, provide mock-up or example of how your idea could look like.
26+
27+
- type: textarea
28+
attributes:
29+
label: Comments
30+
description: Additional information, comments or screenshots about the feature request.

‎PRIVACY-POLICY.md

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
### Privacy Policy
2+
3+
Last updated: June 29, 2024
4+
5+
This Privacy Policy describes Our policies and procedures on the collection, use and disclosure of Your information when You use the Service and tells You about Your privacy rights and how the law protects You.
6+
We use Your anonymous Non-Personal data and health and performance data of the Service to provide and improve the Service itself. By using the Service, You agree to the collection and use of information in accordance with this Privacy Policy.
7+
8+
### Interpretation and Definitions
9+
10+
#### Interpretation
11+
12+
The words of which the initial letter is capitalized have meanings defined under the following conditions.
13+
The following definitions shall have the same meaning regardless of whether they appear in singular or in plural.
14+
15+
#### Definitions
16+
17+
For the purposes of this Privacy Policy:
18+
19+
+ **You** means the individual accessing or using the Service, or the company, or other legal entity on behalf of which such individual is accessing or using the Service, as applicable.
20+
+ **Developer** (referred to as either "the Developer", "We", "Us" or "Our" in this Agreement) refers to CtrlHelp's owner.
21+
+ **Website** refers to CtrlHelp's website, accessible from [github.com/veler/CtrlHelpApp](https://github.com/veler/CtrlHelpApp)
22+
+ **Service** refers to the CtrlHelp software.
23+
+ **Country** refers to: Washington, USA.
24+
+ **Service Provider** means any natural or legal person who processes the data on behalf of the Developer. It refers to third-party developer(s) or individuals contributor to facilitate the Service, to provide the Service on behalf of the Developer, to perform services related to the Service or to assist the Developer in analyzing how the Service is used.
25+
+ **Personal Data** is any information that relates to an identified or identifiable individual.
26+
+ **Non-Personal Data** is any information that does not relates to an identified or identifiable individual.
27+
+ **Device** means any device that can access the Service such as a computer, a cellphone or a digital tablet.
28+
+ **Usage Data** refers to data collected automatically, either generated by the use of the Service or from the Service infrastructure itself (for example, the duration that the Service takes to start).
29+
30+
### Collecting and Using Your Personal Data
31+
32+
#### Types of Data Collected
33+
34+
##### Personal Data
35+
36+
While using Our Service, We will never retain or ask You to provide Us any personally identifiable information.
37+
38+
##### Usage Data
39+
40+
Usage Data is collected automatically when using the Service.
41+
Usage Data may include non-identifiable information such as error messages, performance metric, ordered list of features used during the use of the Service.
42+
Usage Data are not sent to the Developer and Service Provider.
43+
Usage Data are displayed in the "About" section in the Settings page of the Service.
44+
When changing a keyboard shortcut within the app and that You indicate that the shortcut does not match the default, the new shortcut You provide will be automatically sent to the Developer and Service Provider for review. This will help Us to improve the Service and to provide You with a better experience.
45+
46+
### Links to Other Websites
47+
48+
Our Service may contain links to other websites that are not operated by Us. If You click on a third party link, You will be directed to that third party's site. We strongly advise You to review the Privacy Policy of every site You visit.
49+
50+
We have no control over and assume no responsibility for the content, privacy policies or practices of any third party sites or services.
51+
52+
### Third-Party Services
53+
54+
Our Service allow You to use a Third-Party service. We strongly advise You to review the Privacy Policy of every service You use.
55+
56+
We have no control over and assume no responsibility for the content, privacy policies or practices of any third party services.
57+
58+
### Changes to this Privacy Policy
59+
60+
We may update our Privacy Policy from time to time. We will notify You of any changes by posting the new Privacy Policy on this page.
61+
You are advised to review this Privacy Policy periodically for any changes. Changes to this Privacy Policy are effective when they are posted on this page.
62+
63+
### Contact Us
64+
65+
If you have any questions about this Privacy Policy, You can contact us:
66+
67+
+ By sending an email to [[email protected]](mailto:[email protected]?subject=CtrlHelp)

‎README.md

+36-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,36 @@
1-
# CtrlHelpApp
2-
Unleash Your Keyboard's Potential
1+
# CtrlHelp
2+
3+
Welcome to the official repository of CtrlHelp, an application designed to enhance your productivity by providing an extensive list of keyboard shortcuts for various applications. Developed by Etienne Baudoux, CtrlHelp aims to streamline your workflow by making it easier to access and remember shortcuts for your favorite apps.
4+
5+
## Features
6+
7+
- **Comprehensive Shortcut Listings:** Access a wide array of keyboard shortcuts for different applications, all in one place.
8+
- **User-Friendly Interface:** Easily navigate through the application to find the shortcuts you need.
9+
- **Customizable Shortcuts:** Submit your suggestions for new shortcuts or enhancements to existing ones.
10+
11+
## Getting Started
12+
13+
To get started with CtrlHelp, simply download the application from the [Microsoft Store website](https://github.com/veler/CtrlHelpApp) and install it on your Windows 10 or Windows 11 device.
14+
15+
## How to Contribute
16+
17+
We welcome contributions from the community! Whether you have a feature request, want to suggest an enhancement, or have found a bug, your input is valuable to us. Please use the issue templates provided in this repository to submit your contributions:
18+
19+
- [Feature Request](.github/ISSUE_TEMPLATE/feature_request.yml): Suggest a new feature or a new app's keyboard shortcut.
20+
- [Enhancement Request](.github/ISSUE_TEMPLATE/enhancement_request.yml): Propose improvements to existing features.
21+
- [Bug Report](.github/ISSUE_TEMPLATE/bug_report.yml): Report any bugs or issues you encounter while using CtrlHelp.
22+
23+
For general questions about CtrlHelp, please visit our [GitHub discussions](https://github.com/veler/CtrlHelp/discussions).
24+
25+
## Documentation
26+
27+
For more information about using CtrlHelp, please refer to the following documents:
28+
29+
- [Terms of Use](TERM-AND-CONDITIONS.md): Understand the terms and conditions of using CtrlHelp.
30+
- [Privacy Policy](PRIVACY-POLICY.md): Learn how we collect, use, and protect your information.
31+
32+
## License
33+
34+
CtrlHelp is a closed source software. However, the default list of apps and their shortcuts supported in CtrlHelp is open-source, licensed under the [MIT License](LICENSE).
35+
36+
Thank you for using CtrlHelp!

‎TERM-AND-CONDITIONS.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# CtrlHelp - Terms of Use
2+
3+
Please read these Terms of Use ("Terms", "Agreement") carefully before using the CtrlHelp application ("Application") operated by Etienne Baudoux ("us", "we", "our").
4+
5+
## Acceptance of Terms
6+
7+
By using this Application, you certify that you have read, understood, and agreed to be bound by this Agreement. If you do not agree with the terms and conditions of this Agreement, you are advised to discontinue use of the Application immediately and uninstall it. We grant access and use of this Application and its services only to those who have accepted these Terms.
8+
9+
## Privacy policy
10+
11+
Before you continue using our Application, we recommend you read our [privacy policy](https://github.com/veler/CtrlHelpApp/blob/main/PRIVACY-POLICY.md) which governs the manner in which we collect, use, maintain and disclose information collected from users of our Application.
12+
13+
## Intellectual property
14+
15+
You acknowledge and agree that all materials, products, and services provided by this Application are the property of Etienne Baudoux, unless otherwise specified (e.g., software's logo belonging to their respective owners). You agree not to reproduce, redistribute, or exploit any of CtrlHelp's intellectual property in any way, including electronic, digital, or new trademark registrations. You may reuse CtrlHelp's open-source code (such as the list of apps and their keyboard shortcuts) as long as your usage complies with its license. However, names, trademarks, and other non-code content in CtrlHelp must adhere to this Agreement.
16+
17+
## Purchases
18+
19+
By purchasing CtrlHelp, whether via subscription or a one-time payment, you are granted unlimited use of the Application, provided it is officially supported by your operating system, such as Windows 10 and Windows 11.
20+
21+
## Indemnification
22+
23+
You agree to indemnify and hold harmless Etienne Baudoux and its affiliates from and against any and all claims, damages, obligations, losses, liabilities, costs or debt, and expenses (including but not limited to attorney's fees), resulting from or arising out of your use and access of the Application, or a breach of these Terms.
24+
25+
## Limitation or liability
26+
27+
Etienne Baudoux shall not be held liable for any indirect, incidental, special, consequential or punitive damages, including without limitation, loss of profits, data, use, goodwill, or other intangible losses, resulting from your access to or use of or inability to access or use the Application.
28+
29+
## Changes to this agreement
30+
31+
Etienne Baudoux reserves the right to modify, amend, or change this Agreement at any time. We will notify our users of these changes through notices within the Application. This Agreement constitutes the entire understanding between Etienne Baudoux and the user, superseding and replacing all prior agreements regarding the use of this Application and its services.
32+
33+
---
34+
This agreement was last modified on June 29th, 2024.

0 commit comments

Comments
 (0)