Skip to content

Commit a7fabc3

Browse files
ryanfoxtylerryanfoxtyler
authored
chore: add issue and PR templates (#43)
* create bug_report.md * Create feature_request.md * Create config.yml * Create pull_request_template.md * Update README.md
1 parent f43ed88 commit a7fabc3

File tree

5 files changed

+108
-54
lines changed

5 files changed

+108
-54
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
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+
16+
1. Go to '...'
17+
2. Click on '....'
18+
3. Scroll down to '....'
19+
4. See error
20+
21+
**Expected behavior**
22+
A clear and concise description of what you expected to happen.
23+
24+
**Screenshots**
25+
If applicable, add screenshots to help explain your problem.
26+
27+
**Environment**
28+
29+
- OS: [e.g. macOS, Windows, Ubuntu]
30+
- Language [e.g. AssemblyScript, Go]
31+
- Version [e.g. v0.xx]
32+
33+
**Additional context**
34+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Hypermode Community Support
4+
url: https://discord.hypermode.com
5+
about: Please ask and answer questions here

‎.github/ISSUE_TEMPLATE/feature_request.md

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: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
**Description**
2+
3+
Please explain the changes you made here.
4+
5+
**Checklist**
6+
7+
- [ ] Code compiles correctly and linting passes locally
8+
- [ ] Tests added for new functionality, or regression tests for bug fixes added as applicable
9+
- [ ] For new features, etc., PR on [docs repo](https://github.com/hypermodeinc/docs) staged and linked here
10+
11+
**Instructions**
12+
13+
- The PR title should follow the [Conventional Commits](https://www.conventionalcommits.org/) syntax, leading with `fix:`, `feat:`, `chore:`, `ci:`, etc.
14+
- The description should briefly explain what the PR is about. In the case of a bugfix, describe or link to the bug.
15+
- In the checklist section, check the boxes in that are applicable, using `[x]` syntax.
16+
- If not applicable, remove the entire line. Only leave the box unchecked if you intend to come back and check the box later.
17+
- Delete the `Instructions` line and everything below it, to indicate you have read and are following these instructions. 🙂
18+
19+
Thank you for your contribution to the Modus project!

‎README.md

Lines changed: 30 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,48 @@
1-
# hyp
1+
<!-- markdownlint-disable first-line-heading -->
2+
<div align="center">
3+
4+
[![GitHub License](https://img.shields.io/github/license/hypermodeinc/hyp-cli)](https://github.com/hypermodeinc/hyp-cli?tab=Apache-2.0-1-ov-file#readme)
5+
[![chat](https://img.shields.io/discord/1267579648657850441)](https://discord.hypermode.com)
6+
[![GitHub Repo stars](https://img.shields.io/github/stars/hypermodeinc/hyp-cli)](https://github.com/hypermodeinc/hyp-cli/stargazers)
7+
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/hypermodeinc/hyp-cli)](https://github.com/hypermodeinc/hyp-cli/commits/main/)
28

3-
A new CLI for the Hypermode service
9+
</div>
410

5-
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
6-
[![Version](https://img.shields.io/npm/v/hyp.svg)](https://npmjs.org/package/hyp)
7-
[![Downloads/week](https://img.shields.io/npm/dw/hyp.svg)](https://npmjs.org/package/hyp)
11+
<p align="center">
12+
<a href="https://docs.hypermode.com/quickstart">Get Started</a> ·
13+
<a href="https://docs.hypermode.com/hyp-cli">Docs</a> ·
14+
<a href="https://discord.hypermode.com">Discord</a>
15+
<p>
816

9-
<!-- toc -->
17+
Hyp is the command line interface (CLI) for [Hypermode](https://hypermode.com).
1018

11-
- [hyp](#hyp)
12-
- [Usage](#usage)
13-
- [Commands](#commands)
14-
<!-- tocstop -->
19+
## Quickstart
1520

16-
## Usage
21+
Install the Hyp CLI
1722

18-
<!-- usage -->
19-
20-
```sh-session
21-
$ npm install -g @hypermode/hyp-cli
22-
$ hyp COMMAND
23-
running command...
24-
$ hyp (--version)
25-
@hypermode/hyp-cli/0.0.1-alpha.1 darwin-arm64 node-v22.9.0
26-
$ hyp --help [COMMAND]
27-
USAGE
28-
$ hyp COMMAND
29-
...
23+
```bash
24+
npm install -g @hypermode/hyp-cli
3025
```
3126

32-
<!-- usagestop -->
33-
34-
## Commands
35-
36-
<!-- commands -->
37-
38-
- [`hyp login`](#hyp-login)
39-
- [`hyp logout`](#hyp-logout)
40-
- [`hyp org switch`](#hyp-org-switch)
41-
42-
### `hyp login`
27+
Initialize your Modus app
4328

44-
Login to Hypermode Console
45-
46-
```sh
47-
hyp login
29+
```bash
30+
modus new
4831
```
4932

50-
_See code: [src/commands/login/index.ts](https://github.com/hypermodeinc/hyp-cli/blob/v0.0.1-alpha.1/src/commands/login/index.ts)_
51-
52-
### `hyp logout`
53-
54-
Logout of Hypermode Console in the CLI
33+
Run your app locally with fast refresh
5534

56-
```sh
57-
hyp logout
35+
```bash
36+
modus dev
5837
```
5938

60-
_See code: [src/commands/logout/index.ts](https://github.com/hypermodeinc/hyp-cli/blob/v0.0.1-alpha.1/src/commands/logout/index.ts)_
61-
62-
### `hyp org switch`
63-
64-
Switch the current Hypermode organization
39+
Link your Modus app repo to Hypermode
6540

66-
```sh
67-
hyp org switch
41+
```bash
42+
hyp link
6843
```
6944

70-
_See code: [src/commands/org/switch.ts](https://github.com/hypermodeinc/hyp-cli/blob/v0.0.1-alpha.1/src/commands/org/switch.ts)_
45+
## License
7146

72-
<!-- commandsstop -->
47+
Hyp CLI is Copyright 2024 Hypermode Inc., and licensed under the terms of the Apache License, Version 2.0.
48+
See the [LICENSE](./LICENSE) file for a complete copy of the license.

0 commit comments

Comments
 (0)