mirror of
https://github.com/wavetermdev/waveterm.git
synced 2025-01-31 23:11:28 +01:00
PE 178 Add OSS files (#50)
* Add contribution guide * Format improvements * Add security guidelines * Create CODE_OF_CONDUCT.md * Add README.md
This commit is contained in:
Tracy Miranda
GitHub
parent
e5f500e34f
commit
505ab56ef4
7
BUILD.md
7
BUILD.md
@ -21,7 +21,12 @@ brew install scripthaus
|
||||
```
|
||||
|
||||
You also need a relatively modern nodejs with npm and yarn installed.
|
||||
Node can be installed from [here](https://nodejs.org). npm can install yarn using `npm install -g yarn`.
|
||||
* Node can be installed from [https://nodejs.org](https://nodejs.org).
|
||||
* npm can install yarn using:
|
||||
|
||||
```
|
||||
npm install -g yarn
|
||||
```
|
||||
|
||||
## Clone the Repo
|
||||
|
||||
|
||||
128
CODE_OF_CONDUCT.md
Normal file
128
CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,128 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, religion, or sexual identity
|
||||
and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the
|
||||
overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or
|
||||
advances of any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email
|
||||
address, without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
coc@commandline.dev.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series
|
||||
of actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or
|
||||
permanent ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within
|
||||
the community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.0, available at
|
||||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||
|
||||
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||
enforcement ladder](https://github.com/mozilla/diversity).
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
https://www.contributor-covenant.org/faq. Translations are available at
|
||||
https://www.contributor-covenant.org/translations.
|
||||
47
CONTRIBUTING.md
Normal file
47
CONTRIBUTING.md
Normal file
@ -0,0 +1,47 @@
|
||||
# Contributing to Wave Terminal
|
||||
|
||||
We welcome and value contributions to Wave Terminal! Wave is an open source project, always open for contributors. There are several ways you can contribute:
|
||||
* Submit issues related to bugs or new feature requests
|
||||
* Fix outstanding [issues](https://github.com/wavetermdev/waveterm/issues) with the existing code
|
||||
* Contribute to [documentation]()
|
||||
* Spread the word on social media (tag us on [LinkedIn](), [Twitter/X]())
|
||||
* Or simply ⭐️ the repository to show your appreciation
|
||||
|
||||
However you choose to contribute, please be mindful and respect our [code of conduct]().
|
||||
|
||||
> All contributions are highly appreciated! 🥰
|
||||
|
||||
## Before You Start
|
||||
We accept patches in the form of github pull requests. If you are new to github, please review this [github pull request guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
|
||||
|
||||
### Contributor License Agreement
|
||||
Contributions to this project must be accompanied by a Contributor License Agreement (CLA). You (or your employer) retain the copyright to your contribution, this simply gives us permission to use and redistribute your contributions as part of the project.
|
||||
* Individuals: On submission of your first pull request you will be prompted to sign the CLA confirming your original code contribution and that you own the intellectual property.
|
||||
* Companies: Companies may sign a Corporate CLA (link) to allow all employees to contribute.
|
||||
|
||||
### Style guide
|
||||
The project uses American English.
|
||||
|
||||
Coding style and formatting is automated for each pull request. We use [Prettier](https://prettier.io/).
|
||||
|
||||
## How to contribute
|
||||
|
||||
* For minor changes, you are welcome to [open a pull request](https://github.com/wavetermdev/waveterm/pulls).
|
||||
* For major changes, please [create an issue](https://github.com/wavetermdev/waveterm/issues/new) first.
|
||||
* If you are looking for a place to start take a look at [open issues](https://github.com/wavetermdev/waveterm/issues) and [good-first-issues](lh).
|
||||
* Join the [Discord channel]() to collaborate with the community on your contribution.
|
||||
|
||||
|
||||
### Development Environment
|
||||
|
||||
To build and run wave term locally see instructions below:
|
||||
* [MacOS build instructions]()
|
||||
* [Linux build instructions]()
|
||||
|
||||
### Create a Pull Request
|
||||
|
||||
Guidelines:
|
||||
* Before writing any code, please look through existing PRs or issues to make sure nobody is already working on the same thing.
|
||||
* Develop features on a branch - do not work on the main branch
|
||||
* For anything but minor fixes, please submit tests and documentation
|
||||
* Please reference the issue in the pull request
|
||||
50
README.md
Normal file
50
README.md
Normal file
@ -0,0 +1,50 @@
|
||||
|
||||
<p align="center">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="./src/app/assets/wave-logo_horizontal-coloronwhite.svg">
|
||||
<source media="(prefers-color-scheme: light)" srcset="./src/app/assets/wave-logo_horizontal-coloronblack.svg">
|
||||
<img alt="Wave Terminal Logo" src="./src/app/assets/wave-logo_horizontal-coloronblack.svg" width="352" height="59" style="max-width: 100%;">
|
||||
</picture>
|
||||
<br/>
|
||||
</p>
|
||||
|
||||
# Wave Terminal
|
||||
|
||||
The universal modern terminal for seamless workflows.
|
||||
|
||||
Wave isn't just another terminal emulator; it's an AI-powered modern terminal designed for developers to never lose focus. With Wave, you can focus on execution, collaboration and context switching seamlessly.
|
||||
|
||||
### Features
|
||||
|
||||
* Render anything inline: review code, images, even csv files without ever leaving the terminal
|
||||
* Save sessions and history
|
||||
* AI-powered
|
||||
|
||||
## Installation
|
||||
|
||||
Wave Terminal works with MacOS and Linux (preliminary).
|
||||
|
||||
Install Wave Terminal from: [www.commandline.dev/download](https://www.commandline.dev/download)
|
||||
|
||||
## Quick Start
|
||||
|
||||
A quick start guide is available at [docs.getprompt.dev/quickstart/](https://docs.getprompt.dev/quickstart/)
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation is available at [docs.getprompt.dev](https://docs.getprompt.dev/)
|
||||
|
||||
## Community
|
||||
* Joins us on Discord
|
||||
|
||||
## Contributing
|
||||
|
||||
Wave uses Github Project for tracking issues.
|
||||
|
||||
Find more information in our [Contributions Guide](), which includes:
|
||||
|
||||
* Ways to contribute
|
||||
* How to build and run from source
|
||||
* Contribution guidelines
|
||||
|
||||
|
||||
5
SECURITY.md
Normal file
5
SECURITY.md
Normal file
@ -0,0 +1,5 @@
|
||||
## Reporting Security Issues
|
||||
|
||||
To report vulnerabilities or security concerns, please email us at: [security@commandline.dev](mailto:security@commandline.dev)
|
||||
|
||||
** Please do not report security vulnerabilities through public github issues. **
|
||||
50
src/app/assets/wave-logo_horizontal-coloronblack.svg
Normal file
50
src/app/assets/wave-logo_horizontal-coloronblack.svg
Normal file
@ -0,0 +1,50 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- Generator: Adobe Illustrator 27.8.1, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
|
||||
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
||||
viewBox="0 0 1000 175" style="enable-background:new 0 0 1000 175;" xml:space="preserve">
|
||||
<style type="text/css">
|
||||
.st0{fill:url(#SVGID_1_);}
|
||||
.st1{fill:url(#SVGID_00000091720229019135579030000007505974356775393451_);}
|
||||
.st2{fill:#FFFFFF;}
|
||||
.st3{fill:#58C142;}
|
||||
.st4{fill:url(#SVGID_00000057844994756141690520000013392915125647203757_);}
|
||||
.st5{fill:url(#SVGID_00000122684313424325124480000003010239515924857535_);}
|
||||
.st6{fill:url(#SVGID_00000075883355893983351890000012882526639983753630_);}
|
||||
.st7{fill:url(#SVGID_00000000207897583077398290000006853703841187474602_);}
|
||||
.st8{fill:url(#SVGID_00000008108614519912429220000010116473681835506344_);}
|
||||
.st9{fill:url(#SVGID_00000132058454267173112380000008245439973034275726_);}
|
||||
.st10{fill:url(#SVGID_00000034804588790703597750000013460998990473107363_);}
|
||||
.st11{fill:url(#SVGID_00000131349218605867433520000014539481291819864990_);}
|
||||
.st12{fill:url(#SVGID_00000003071904852992499350000013371332860686737080_);}
|
||||
.st13{fill:url(#SVGID_00000072278415138862792700000002042113538205077667_);}
|
||||
</style>
|
||||
<g>
|
||||
<path class="st3" d="M339.7,20.6h26.5l30.9,100.8l33.5-100.8h22l33.5,100.8l31.2-100.8h26.5L497.9,156h-23.8L441.9,55.4L409.1,156
|
||||
h-23.8L339.7,20.6z"/>
|
||||
<path class="st3" d="M693.8,20.6V156h-25.9V133c-10.5,16.2-27.2,26.2-47.9,26.2c-35.9,0-62.3-29.3-62.3-71
|
||||
c0-41.4,26.5-70.7,62.3-70.7c20.7,0,37.5,10,47.9,26.2v-23H693.8z M667.9,88.2c0-28.3-17.3-48.2-41.9-48.2
|
||||
c-24.6,0-42.2,19.9-42.2,48.2c0,28.3,17.6,48.5,42.2,48.5C650.6,136.6,667.9,116.5,667.9,88.2z"/>
|
||||
<path class="st3" d="M713.8,20.6h27.8l42.2,105.3l41.4-105.3h28L796,156h-24.4L713.8,20.6z"/>
|
||||
<path class="st3" d="M970.7,122.2l15.2,16c-11.8,12.8-35.6,21-54.7,21c-37.5,0-69.9-29.6-69.9-71.2c0-40.6,30.6-70.5,68.1-70.5
|
||||
c41.4,0,65.5,30.9,65.5,79.1H886.6c3.1,23.8,19.9,41.1,44,41.1C945.3,137.7,962.3,131.1,970.7,122.2z M886.9,77.5h82.8
|
||||
c-2.6-21.7-16.2-38.5-39.8-38.5C908.1,38.9,890.8,54.1,886.9,77.5z"/>
|
||||
</g>
|
||||
<g>
|
||||
<linearGradient id="SVGID_1_" gradientUnits="userSpaceOnUse" x1="5.2128" y1="58.9088" x2="240.4477" y2="58.9088">
|
||||
<stop offset="0.1418" style="stop-color:#1F4D22"/>
|
||||
<stop offset="0.8656" style="stop-color:#418D31"/>
|
||||
</linearGradient>
|
||||
<path class="st0" d="M83.6,80.8c-12.3,0-19.1,8-22.8,25.9l-55.6-8C12,40.1,34.8,11.7,79.9,11.7C113.3,11.7,146,37,162,37
|
||||
c12.4,0,19.1-8.6,22.8-25.9l55.6,8c-6.2,58.7-29.6,87.1-74.7,87.1C131.8,106.1,100.3,80.8,83.6,80.8z"/>
|
||||
</g>
|
||||
<g>
|
||||
|
||||
<linearGradient id="SVGID_00000145018229965941010500000002424778669397199792_" gradientUnits="userSpaceOnUse" x1="20.9171" y1="116.0912" x2="256.1519" y2="116.0912">
|
||||
<stop offset="0.2223" style="stop-color:#418D31"/>
|
||||
<stop offset="0.7733" style="stop-color:#58C142"/>
|
||||
</linearGradient>
|
||||
<path style="fill:url(#SVGID_00000145018229965941010500000002424778669397199792_);" d="M99.3,138c-12.3,0-19.1,8-22.8,25.9
|
||||
l-55.6-8c6.8-58.6,29.6-87.1,74.7-87.1c33.3,0,66.1,25.3,82.1,25.3c12.4,0,19.1-8.6,22.8-25.9l55.6,8
|
||||
c-6.2,58.7-29.6,87.1-74.7,87.1C147.5,163.3,116,138,99.3,138z"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 3.2 KiB |
50
src/app/assets/wave-logo_horizontal-coloronwhite.svg
Normal file
50
src/app/assets/wave-logo_horizontal-coloronwhite.svg
Normal file
@ -0,0 +1,50 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- Generator: Adobe Illustrator 27.8.1, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
|
||||
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
||||
viewBox="0 0 1000 175" style="enable-background:new 0 0 1000 175;" xml:space="preserve">
|
||||
<style type="text/css">
|
||||
.st0{fill:url(#SVGID_1_);}
|
||||
.st1{fill:url(#SVGID_00000097467401116752621440000013265923851559160252_);}
|
||||
.st2{fill:#FFFFFF;}
|
||||
.st3{fill:#58C142;}
|
||||
.st4{fill:url(#SVGID_00000026844058065691411450000001084298207851076753_);}
|
||||
.st5{fill:url(#SVGID_00000140695609015829564530000017877493759276215708_);}
|
||||
.st6{fill:url(#SVGID_00000172429467579424709090000016892278147863045285_);}
|
||||
.st7{fill:url(#SVGID_00000111161844774090145740000012271107721736914070_);}
|
||||
.st8{fill:url(#SVGID_00000159463458951391818050000007934417898368699555_);}
|
||||
.st9{fill:url(#SVGID_00000114048161574266679140000001630328408055608234_);}
|
||||
.st10{fill:url(#SVGID_00000181790832707237646570000012870231436607310721_);}
|
||||
.st11{fill:url(#SVGID_00000182504551275047381220000018143622223532349093_);}
|
||||
.st12{fill:url(#SVGID_00000182503296231706301150000015159284117431565225_);}
|
||||
.st13{fill:url(#SVGID_00000157991892590648824540000004483708798912232327_);}
|
||||
</style>
|
||||
<g>
|
||||
<path d="M339.7,20.6h26.5l30.9,100.8l33.5-100.8h22l33.5,100.8l31.2-100.8h26.5L497.9,156h-23.8L441.9,55.4L409.1,156h-23.8
|
||||
L339.7,20.6z"/>
|
||||
<path d="M693.8,20.6V156h-25.9V133c-10.5,16.2-27.2,26.2-47.9,26.2c-35.9,0-62.3-29.3-62.3-71c0-41.4,26.5-70.7,62.3-70.7
|
||||
c20.7,0,37.5,10,47.9,26.2v-23H693.8z M667.9,88.2c0-28.3-17.3-48.2-41.9-48.2c-24.6,0-42.2,19.9-42.2,48.2
|
||||
c0,28.3,17.6,48.5,42.2,48.5C650.6,136.6,667.9,116.5,667.9,88.2z"/>
|
||||
<path d="M713.8,20.6h27.8l42.2,105.3l41.4-105.3h28L796,156h-24.4L713.8,20.6z"/>
|
||||
<path d="M970.7,122.2l15.2,16c-11.8,12.8-35.6,21-54.7,21c-37.5,0-69.9-29.6-69.9-71.2c0-40.6,30.6-70.5,68.1-70.5
|
||||
c41.4,0,65.5,30.9,65.5,79.1H886.6c3.1,23.8,19.9,41.1,44,41.1C945.3,137.7,962.3,131.1,970.7,122.2z M886.9,77.5h82.8
|
||||
c-2.6-21.7-16.2-38.5-39.8-38.5C908.1,38.9,890.8,54.1,886.9,77.5z"/>
|
||||
</g>
|
||||
<g>
|
||||
<linearGradient id="SVGID_1_" gradientUnits="userSpaceOnUse" x1="5.2128" y1="58.9088" x2="240.4477" y2="58.9088">
|
||||
<stop offset="0.1418" style="stop-color:#1F4D22"/>
|
||||
<stop offset="0.8656" style="stop-color:#418D31"/>
|
||||
</linearGradient>
|
||||
<path class="st0" d="M83.6,80.8c-12.3,0-19.1,8-22.8,25.9l-55.6-8C12,40.1,34.8,11.7,79.9,11.7C113.3,11.7,146,37,162,37
|
||||
c12.4,0,19.1-8.6,22.8-25.9l55.6,8c-6.2,58.7-29.6,87.1-74.7,87.1C131.8,106.1,100.3,80.8,83.6,80.8z"/>
|
||||
</g>
|
||||
<g>
|
||||
|
||||
<linearGradient id="SVGID_00000055697211621202625680000016003686276294146176_" gradientUnits="userSpaceOnUse" x1="20.9171" y1="116.0912" x2="256.1519" y2="116.0912">
|
||||
<stop offset="0.2223" style="stop-color:#418D31"/>
|
||||
<stop offset="0.7733" style="stop-color:#58C142"/>
|
||||
</linearGradient>
|
||||
<path style="fill:url(#SVGID_00000055697211621202625680000016003686276294146176_);" d="M99.3,138c-12.3,0-19.1,8-22.8,25.9
|
||||
l-55.6-8c6.8-58.6,29.6-87.1,74.7-87.1c33.3,0,66.1,25.3,82.1,25.3c12.4,0,19.1-8.6,22.8-25.9l55.6,8
|
||||
c-6.2,58.7-29.6,87.1-74.7,87.1C147.5,163.3,116,138,99.3,138z"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 3.1 KiB |
Loading…
Reference in New Issue
Block a user