mirror of
https://github.com/jeanp413/open-remote-ssh.git
synced 2026-07-16 19:17:11 +02:00
docs: add contributing and code of conduct (#284)
CI - Master: Build & Lint / check (push) Has been cancelled
CI - Master: Build & Lint / check (push) Has been cancelled
This commit is contained in:
Baptiste Augrain
@@ -0,0 +1,85 @@
|
||||
labels:
|
||||
- S-needs-triage
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: "# Issue Details"
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Issue Description
|
||||
description: Provide a detailed description of the issue. Include relevant informations.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: Describe how you expect this project to behave in this situation. Include any relevant documentation links.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Actual Behavior
|
||||
description: Describe how this project actually behaves in this situation. If it is not immediately obvious how the actual behavior differs from the expected behavior described above, please be sure to mention the deviation specifically.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Reproduction Steps
|
||||
description: Provide a detailed set of step-by-step instructions for reproducing this issue.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
attributes:
|
||||
label: Editor Name & Version
|
||||
placeholder: VSCode v1.110.0
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
attributes:
|
||||
label: Extension Version
|
||||
placeholder: v0.1.2
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Environment
|
||||
description: Paste the output of `npx envinfo --system` here.
|
||||
render: text
|
||||
placeholder: System
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |-
|
||||
# User Acknowledgements
|
||||
> [!TIP]
|
||||
> Use these links to review the existing [Issues](https://github.com/jeanp413/open-remote-ssh/issues?q=sort%3Areactions-desc).
|
||||
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Validations
|
||||
description: "Before submitting the issue, please make sure you acknowledge that:"
|
||||
options:
|
||||
- label: I have reviewed the FAQ and confirm that my issue is NOT among them.
|
||||
required: true
|
||||
- label: I have searched the repository (both open and closed Issues) and confirm this is not a duplicate of an existing issue.
|
||||
required: true
|
||||
- label: I have checked the "Preview" tab on all text fields to ensure that everything looks right, and have wrapped all configuration and code in code blocks with a group of three backticks (` ``` `) on separate lines.
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Contributions
|
||||
description: Please note that Open Source projects are maintained by volunteers, where your cases might not be always relevant to the others. It would make things move faster if you could help investigate and propose solutions.
|
||||
options:
|
||||
- label: I am willing to submit a PR to fix this issue
|
||||
|
||||
@@ -0,0 +1,89 @@
|
||||
# Contributor Covenant 3.0 Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We pledge to make our community welcoming, safe, and equitable for all.
|
||||
|
||||
We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
|
||||
|
||||
|
||||
## Encouraged Behaviors
|
||||
|
||||
While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
|
||||
|
||||
With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
|
||||
|
||||
1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
|
||||
2. Engaging **kindly and honestly** with others.
|
||||
3. Respecting **different viewpoints** and experiences.
|
||||
4. **Taking responsibility** for our actions and contributions.
|
||||
5. Gracefully giving and accepting **constructive feedback**.
|
||||
6. Committing to **repairing harm** when it occurs.
|
||||
7. Behaving in other ways that promote and sustain the **well-being of our community**.
|
||||
|
||||
|
||||
## Restricted Behaviors
|
||||
|
||||
We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
|
||||
|
||||
1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
|
||||
2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
|
||||
3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
|
||||
4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
|
||||
5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
|
||||
6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
|
||||
7. Behaving in other ways that **threaten the well-being** of our community.
|
||||
|
||||
### Other Restrictions
|
||||
|
||||
1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
|
||||
2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
|
||||
3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
|
||||
4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
|
||||
|
||||
|
||||
## Reporting an Issue
|
||||
|
||||
Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
|
||||
|
||||
When an incident does occur, it is important to report it promptly. To report a possible violation, please email a project maintainer.
|
||||
|
||||
Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
|
||||
|
||||
|
||||
## Addressing and Repairing Harm
|
||||
|
||||
If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
|
||||
|
||||
1) Warning
|
||||
1) Event: A violation involving a single incident or series of incidents.
|
||||
2) Consequence: A private, written warning from the Community Moderators.
|
||||
3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
|
||||
2) Temporarily Limited Activities
|
||||
1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
|
||||
2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
|
||||
3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
|
||||
3) Temporary Suspension
|
||||
1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
|
||||
2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
|
||||
3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
|
||||
4) Permanent Ban
|
||||
1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
|
||||
2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
|
||||
3) Repair: There is no possible repair in cases of this severity.
|
||||
|
||||
This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
|
||||
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
|
||||
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
|
||||
|
||||
Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
|
||||
|
||||
For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).
|
||||
@@ -0,0 +1,87 @@
|
||||
# Contributing
|
||||
|
||||
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
|
||||
|
||||
This document is intended for anyone considering opening an **issue**, **discussion** or **pull request**.
|
||||
|
||||
#### Table Of Contents
|
||||
|
||||
- [Code of Conduct](#code-of-conduct)
|
||||
- [Use of AI](#use-of-ai)
|
||||
- [I have a bug! / Something isn't working](#i-have-a-bug--something-isnt-working)
|
||||
- [I have an idea for a feature](#i-have-an-idea-for-a-feature)
|
||||
- [I want to make changes](#i-want-to-make-changes)
|
||||
- [Spread the word](#spread-the-word)
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
|
||||
|
||||
## Use of AI
|
||||
|
||||
We welcome use of AI tools to help draft discussions, issues, or code, but please follow these rules:
|
||||
|
||||
- Use AI tools responsibly and disclose their use.
|
||||
- Ensure all content passes a human review for authenticity and quality.
|
||||
- Be concise. Do not write verbose discussions, issues or PR.
|
||||
|
||||
Discussions, issues or PR that consist solely of unvetted AI outputs may be closed at the maintainer's discretion.
|
||||
|
||||
## I have a bug! / Something isn't working
|
||||
|
||||
First, search the issue tracker for similar issues.<br />
|
||||
Tip: also search for [closed issues]; your issue might have already been fixed!
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> If there is an _open_ issue that matches your problem, **please do not comment on it unless you have valuable insight to add**.
|
||||
>
|
||||
> Use the emoji reactions on issues, which are a visible yet non-disruptive way to show your support.
|
||||
|
||||
If your issue hasn't been reported already, open a new issue and make sure to fill in the template **completely**. They are vital for maintainers to figure out important details about your setup.
|
||||
|
||||
[closed issues]: https://github.com/jeanp413/open-remote-ssh/issues?q=is%3Aissue%20state%3Aclosed
|
||||
|
||||
## I have an idea for a feature
|
||||
|
||||
Like bug reports, first search through issues and try to find if your feature has already been requested. Otherwise, open a new issue.
|
||||
|
||||
## I want to make changes
|
||||
|
||||
Small and trivial improvements can be submitted without any issues.
|
||||
|
||||
**For non-trivial changes**, pull requests should be associated with a **previously accepted issue**.<br />
|
||||
It's always better to ask for prior approval and discuss what you want to do before doing it.
|
||||
|
||||
Discussing that you want to do something doesn't put any obligations on you. If you don't want to start the discussion just because you're afraid that you won't do it. Don't be afraid!
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> **Pull requests are NOT a place to discuss feature design.** Please do not open a WIP pull request to discuss a feature. Instead, use an issue and link to your branch.
|
||||
|
||||
### Code hygiene
|
||||
|
||||
When implementing features and bug fixes, please stick to the structure of the codebase as much as possible and do not take this as an opportunity to do some "refactoring along the way".
|
||||
|
||||
Similarly:
|
||||
- **Make your changes** following our code standards
|
||||
- **Test your changes** thoroughly
|
||||
- **Update documentation** if needed
|
||||
- **Commit your changes** with clear, descriptive commit messages
|
||||
|
||||
### Version
|
||||
|
||||
Do not bump the version number.
|
||||
|
||||
### CHANGELOG.md
|
||||
|
||||
Do not add an entry to the `CHANGELOG.md` file.
|
||||
|
||||
## Spread the word
|
||||
|
||||
Do you like the project?
|
||||
|
||||
* Spread the word in social networks!
|
||||
* Talk about it to your colleagues and friends
|
||||
* Write a blogpost
|
||||
* Record a YouTube video
|
||||
@@ -18,6 +18,11 @@ You can connect to a running SSH server on the following platforms.
|
||||
|
||||
## Requirements
|
||||
|
||||
**Configuration**
|
||||
|
||||
You SSH server's configuration needs to have the following setting:
|
||||
- `AllowTcpForwarding yes`
|
||||
|
||||
**Activation**
|
||||
|
||||
> NOTE: Not needed in VSCodium since version 1.75
|
||||
@@ -48,7 +53,8 @@ sudo apk add bash libstdc++
|
||||
|
||||
## SSH configuration file
|
||||
|
||||
[OpenSSH](https://www.openssh.com/) supports using a [configuration file](https://linuxize.com/post/using-the-ssh-config-file/) to store all your different SSH connections. To use an SSH config file, run the `Remote-SSH: Open SSH Configuration File...` command.
|
||||
[OpenSSH](https://www.openssh.com/) supports using a [configuration file](https://linuxize.com/post/using-the-ssh-config-file/) to store all your different SSH connections.
|
||||
To use an SSH config file, run the `Remote-SSH: Open SSH Configuration File...` command.
|
||||
|
||||
## Note for VSCode-OSS users
|
||||
|
||||
|
||||
Reference in New Issue
Block a user