-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add readme, contributing and code of conduct
- Loading branch information
Showing
3 changed files
with
132 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Contributor Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment include: | ||
|
||
- Using welcoming and inclusive language | ||
- Being respectful of differing viewpoints and experiences | ||
- Gracefully accepting constructive criticism | ||
- Focusing on what is best for the community | ||
- Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
- The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
- Trolling, insulting/derogatory comments, and personal or political attacks | ||
- Public or private harassment | ||
- Publishing others' private information, such as a physical or electronic address, without explicit permission | ||
- Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project email 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 by contacting the project owner at [iam@icm.hrdtr.dev](mailto:iam@icm.hrdtr.dev). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html). | ||
|
||
For answers to common questions about this code of conduct, see [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# Contributing to Echo | ||
|
||
Thank you for your interest in contributing to Echo! Whether you're reporting bugs, suggesting enhancements, or contributing code, your help is appreciated. | ||
|
||
## Code of Conduct | ||
|
||
Please note that this project is released with a [Contributor Code of Conduct](https://github.com/Hrdtr/echo/blob/main/CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms. | ||
|
||
## How to Contribute | ||
|
||
### Reporting Bugs | ||
|
||
- Check if the bug has already been reported by searching the [Issues](https://github.com/Hrdtr/echo/issues). | ||
- If not, open a new issue. Clearly describe the issue, including steps to reproduce it. | ||
|
||
### Suggesting Enhancements | ||
|
||
- Open an issue to discuss your idea before making changes. | ||
- Clearly describe the enhancement and why it would be valuable. | ||
- If you're willing to implement it, let us know! | ||
|
||
### Contributing Code | ||
|
||
1. Fork the repository and create a new branch for your feature or bug fix. | ||
2. Follow the [style guide](#style-guide) and ensure your changes pass any existing tests. | ||
3. Submit a pull request with a clear description of your changes. | ||
|
||
### Style Guide | ||
|
||
Maintain a consistent coding style: | ||
|
||
- Use meaningful variable and function names. | ||
- Follow the established coding patterns in the existing codebase. | ||
|
||
## Development Setup | ||
|
||
If you want to set up a development environment for Echo, follow these steps: | ||
|
||
1. Clone your forked repository. | ||
2. Install project dependencies with `pnpm install`. | ||
3. Start the development server with `pnpm dev`. | ||
|
||
## Community | ||
|
||
Join the conversation and get help: | ||
|
||
- ~~[Chat on Discord](#link-to-discord)~~ | ||
- [File an Issue](https://github.com/Hrdtr/echo/issues) | ||
|
||
## License | ||
|
||
By contributing to Echo, you agree that your contributions will be licensed under the [GPL-3.0 license](https://github.com/Hrdtr/echo/blob/main/LICENSE). | ||
|
||
Thank you for your contribution! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Echo | ||
|
||
<img align="right" src="https://github.com/Hrdtr/echo/blob/main/public/icon-rounded.png?raw=true" width="86" height="86" /> | ||
|
||
**Open-source secure remote host management** | ||
|
||
[![GitHub license](https://img.shields.io/github/license/Hrdtr/echo.svg)](https://github.com/Hrdtr/echo/blob/main/LICENSE) | ||
[![GitHub release](https://img.shields.io/github/release/Hrdtr/echo.svg)](https://github.com/Hrdtr/echo/releases) | ||
|
||
## Overview | ||
|
||
Echo is a secure remote host management tool with built-in SSH shell session terminal capabilities. It allows you to manage hosts efficiently and securely. | ||
|
||
## Features | ||
|
||
- **Host Management:** Easily manage your hosts | ||
- **Shell Session Terminal:** Connect to hosts securely | ||
|
||
## Todos | ||
|
||
- SFTP Support | ||
- macOS Build | ||
- Windows Build | ||
- Account Synchronization | ||
- Team/Shared Host | ||
|
||
## Download | ||
|
||
Download the latest release from the [Releases](https://github.com/Hrdtr/echo/releases) page. | ||
|
||
## License | ||
|
||
This project is licensed under the [GPL-3.0 license](https://github.com/Hrdtr/echo/blob/main/LICENSE) |