feat: readme rework (#1724)
Signed-off-by: Ivan Dagelic <dagelic.ivan@gmail.com>
This commit is contained in:
Ivan Dagelic
committed by
Toma Puljak
Toma Puljak
parent
be83616c1c
commit
5e75df4623
@@ -1,14 +1,3 @@
|
||||
<br>
|
||||
|
||||
<div align="center">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/daytonaio/daytona/raw/main/assets/images/Daytona-logotype-white.png">
|
||||
<img alt="Daytona logo" src="https://github.com/daytonaio/daytona/raw/main/assets/images/Daytona-logotype-black.png" width="40%">
|
||||
</picture>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://www.daytona.io/docs)
|
||||
@@ -16,76 +5,56 @@
|
||||
[](https://goreportcard.com/report/github.com/daytonaio/daytona)
|
||||
[](https://github.com/daytonaio/daytona/issues)
|
||||
|
||||
<br>
|
||||
[](https://console.algora.io/org/daytonaio/bounties?status=open)
|
||||
[](https://console.algora.io/org/daytonaio/bounties?status=completed)
|
||||
|
||||
<br>
|
||||
|
||||
<a href="https://www.producthunt.com/posts/daytona?utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-daytona" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=445392&theme=light&period=daily" alt="Daytona - Dev environment manager that makes you 2x more productive | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
||||
<a href="https://www.producthunt.com/posts/daytona?utm_source=badge-top-post-topic-badge&utm_medium=badge&utm_souce=badge-daytona" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-topic-badge.svg?post_id=445392&theme=light&period=weekly&topic_id=267" alt="Daytona - Dev environment manager that makes you 2x more productive | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
||||
|
||||
</div>
|
||||
|
||||
<h1 align="center">The Open Source Development Environment Manager</h1>
|
||||
|
||||
|
||||
<div align="center">
|
||||
Set up a development environment on any infrastructure, with a single command.
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/daytonaio/daytona/raw/main/assets/images/Daytona-logotype-white.png">
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://github.com/daytonaio/daytona/raw/main/assets/images/Daytona-logotype-black.png">
|
||||
<img alt="Daytona logo" src="https://github.com/daytonaio/daytona/raw/main/assets/images/Daytona-logotype-black.png" width="50%">
|
||||
</picture>
|
||||
</div>
|
||||
|
||||
<h3 align="center">
|
||||
Set up a development environment on any infrastructure using a single command:
|
||||
</h3>
|
||||
|
||||
<div style="width: 80%; margin: 0 auto;">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</br>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://www.daytona.io/docs">Documentation</a>
|
||||
·
|
||||
<a href="https://github.com/daytonaio/daytona/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=%F0%9F%90%9B+Bug+Report%3A+">Report Bug</a>
|
||||
·
|
||||
<a href="https://github.com/daytonaio/daytona/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=%F0%9F%9A%80+Feature%3A+">Request Feature</a>
|
||||
·
|
||||
<a href="https://go.daytona.io/slack">Join Our Slack</a>
|
||||
·
|
||||
<a href="https://twitter.com/daytonaio">Twitter</a>
|
||||
</p>
|
||||
<a href="https://www.daytona.io/docs"> Documentation </a>·
|
||||
<a href="https://github.com/daytonaio/daytona/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=%F0%9F%90%9B+Bug+Report%3A+"> Report Bug </a>·
|
||||
<a href="https://github.com/daytonaio/daytona/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=%F0%9F%9A%80+Feature%3A+"> Request Feature </a>·
|
||||
<a href="https://go.daytona.io/slack"> Join Our Slack </a>·
|
||||
<a href="https://x.com/daytonaio"> Connect On X </a>
|
||||
</p>
|
||||
|
||||
<div align="center"><img src="https://github.com/daytonaio/daytona/raw/main/assets/images/daytona_demo.gif" width="50%" ></div>
|
||||
<div align="center">
|
||||
|
||||
## Features
|
||||
# Open Source Development Environment Manager
|
||||
</div>
|
||||
|
||||
- **Single Command**: Activate a fully configured development environment with a single command.
|
||||
- **Runs everywhere**: spin up your development environment on any machine — whether it's local, remote, cloud-based, physical server, or a VM & any architecture x86 or ARM.
|
||||
- **Configuration File Support**: Initially support for [dev container](https://containers.dev/), ability to expand to DevFile, Nix & Flox (Contributions welcome here!).
|
||||
- **Prebuilds System**: Drastically improve environment setup times (Contributions welcome here!).
|
||||
- **IDE Support** : Seamlessly supports [VS Code](https://github.com/microsoft/vscode) & [JetBrains](https://www.jetbrains.com/remote-development/gateway/) locally, ready to use without configuration. Includes a built-in Web IDE for added convenience.
|
||||
- **Git Provider Integration**: GitHub, GitLab, Bitbucket, Bitbucket Server, Gitea, Gitness, Azure DevOps, AWS CodeCommit, Gogs & Gitee can be connected, allowing easy repo branch or PR pull and commit back from the targets.
|
||||
- **Multiple Workspace Targets**: Support for multiple workspace repositories in the same target, making it easy to develop using a micro-service architecture.
|
||||
- **Reverse Proxy Integration**: Enable collaboration and streamline feedback loops by leveraging reverse proxy functionality. Access preview ports and the Web IDE seamlessly, even behind firewalls.
|
||||
- **Extensibility**: Enable extensibility with plugin or provider development. Moreover, in any dynamic language, not just Go (Contributions welcome here!).
|
||||
- **Security**: Automatically creates a VPN connection between the client machine and the development environment, ensuring a fully secure connection.
|
||||
- **All Ports**: The VPN connection enables access to all ports on the development environments, removing the need to setup port forwards over SSH connection.
|
||||
- **Works on my Machine**: Never experience it again.
|
||||
|
||||
## Quick Start
|
||||
For detailed/manual setup steps click [here](https://www.daytona.io/docs/installation/installation/#installation)
|
||||
|
||||
### Mac / Linux
|
||||
|
||||
```bash
|
||||
curl -sfL https://download.daytona.io/daytona/install.sh | sudo bash && daytona server -y && daytona
|
||||
curl -sfL get.daytona.io | sudo bash && daytona server -y && daytona
|
||||
```
|
||||
|
||||
### Windows
|
||||
|
||||
<details>
|
||||
<summary>Windows PowerShell</summary>
|
||||
This command downloads and installs Daytona and runs the Daytona Server:
|
||||
|
||||
```pwsh
|
||||
$architecture = if ($env:PROCESSOR_ARCHITECTURE -eq "AMD64") { "amd64" } else { "arm64" }
|
||||
md -Force "$Env:APPDATA\bin\daytona"; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]'Tls,Tls11,Tls12';
|
||||
Invoke-WebRequest -URI "https://download.daytona.io/daytona/latest/daytona-windows-$architecture.exe" -OutFile "$Env:APPDATA\bin\daytona\daytona.exe";
|
||||
$env:Path += ";" + $Env:APPDATA + "\bin\daytona"; [Environment]::SetEnvironmentVariable("Path", $env:Path, [System.EnvironmentVariableTarget]::User);
|
||||
daytona serve;
|
||||
powershell -Command "irm https://get.daytona.io/windows | iex; daytona serve"
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Create your first dev environment by opening a new terminal, and running:
|
||||
|
||||
```bash
|
||||
@@ -96,327 +65,94 @@ daytona create
|
||||
|
||||
---
|
||||
|
||||
</br>
|
||||
## Features
|
||||
|
||||
## Why Daytona?
|
||||
- **Quick Setup**: Activate a fully configured development environment with a single command - `daytona create`.
|
||||
- **Runs everywhere**: Spin up your development environment on any machine; local, remote, cloud-based, physical server or a VM & on any architecture; x86 or ARM.
|
||||
- **Various Providers Support**: Choose popular providers like AWS, GCP, Azure, DigitalOcean & [more](https://github.com/orgs/daytonaio/repositories?q=daytona-provider) or use Docker on bare metal.
|
||||
- **IDE Support** : Seamlessly supports [VS Code](https://github.com/microsoft/vscode), [JetBrains](https://www.jetbrains.com/remote-development/gateway/) products and more, ready to use without configuration. Also includes a built-in Web IDE for convenience.
|
||||
- **Git Provider Integration**: GitHub, GitLab, Bitbucket and [other](https://www.daytona.io/docs/configuration/git-providers/#add-a-git-provider) Git providers can be connected allowing you to start working on a specific branch or PR and to push changes immediately.
|
||||
- **Configuration File Support**: Support for [dev container](https://containers.dev/) and an upcoming expansion to DevFile, Nix & Flox.
|
||||
- **Prebuilds System**: Drastically improve environment build times by prebuilding them based on Git Providers' hook events.
|
||||
- **Reverse Proxy Integration**: Enable collaboration and streamline feedback loops by leveraging our reverse proxy. Access preview ports and the Web IDE seamlessly, even behind firewalls.
|
||||
- **Security**: Automatically creates a VPN connection between the client machine and the development environment, ensuring a fully secure connection.
|
||||
- **Works on my Machine**: Never experience it again.
|
||||
|
||||
Daytona is a radically simple open source development environment manager.
|
||||
*For a complete feature set including Authentication, Authorization, Observability, Resource Management and IDP, check out our [enterprise offering](https://daytona.zapier.app/).
|
||||
|
||||
Setting up development environments has become increasingly challenging over time, especially when aiming to set up remotely, where the complexity increases by an order of magnitude. The process is so complex that we've compiled a [comprehensive guide](https://www.daytona.io/dotfiles/diy-guide-to-transform-any-machine-into-a-codespace) detailing all the necessary steps to set one up—spanning **5,000 words**, **7 steps**, and requiring anywhere from 15 to **45 minutes**.
|
||||
|
||||
This complexity is unnecessary.
|
||||
|
||||
With Daytona, you need only to execute a single command: `daytona create`.
|
||||
|
||||
Daytona automates the entire process; provisioning the instance, interpreting and applying the configuration, setting up prebuilds, establishing a secure VPN connection, securely connecting your local or a Web IDE, and assigning a fully qualified domain name to the development environment for easy sharing and collaboration.
|
||||
|
||||
As a developer, you can immediately start focusing on what matters most—your code.
|
||||
|
||||
## Backstory
|
||||
|
||||
We spent most of our careers building cloud development environments. In 2009, we launched what was likely the first commercial [Cloud IDE](https://codeanywhere.com) project. At that time, technology was lacking, forcing us to develop everything from scratch—the IDE, the environment orchestrator, and almost everything else. A lot of people were interested, and over 2.5 million developers signed up! But we were too early, and we asked too much from our users to change how they worked.
|
||||
|
||||
Now, 15 years since its inception, we have noticed quite a few things. First, the technology we wished for back then exists now. Second, approximately 50% of developers work in remote dev environments, and third, and most importantly, setting up development environments has become more complex than ever, both locally and to a greater magnitude for remote.
|
||||
|
||||
So, we took everything we learned and decided to solve these issues once and for all as a fully open-source project. Our goal was to create a single binary that allows you to set up a development environment anywhere you wish, completely free, and finally fulfill the promise that many have attempted to make.
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Requirements
|
||||
|
||||
Before starting the installation script, please go over all the necessary requirements:
|
||||
|
||||
- **Hardware Resources**: Depending on the project requirements, ensure your machine has sufficient resources. Minimum hardware specification is 1cpu, 2GB of RAM and 10GB of disk space.
|
||||
- **Docker**: Ensure [Docker](https://www.docker.com/products/docker-desktop/) is installed and running.
|
||||
|
||||
### Installing Daytona
|
||||
|
||||
Daytona allows you to manage your Development Environments using the Daytona CLI. To install it, please execute the following command:
|
||||
|
||||
```bash
|
||||
# Install Daytona into /usr/local/bin
|
||||
curl -sf -L https://download.daytona.io/daytona/install.sh | sudo bash
|
||||
|
||||
# OR if you want to install Daytona to some other path where you don`t need sudo
|
||||
# curl -sf -L https://download.daytona.io/daytona/install.sh | DAYTONA_PATH=/home/user/bin bash
|
||||
```
|
||||
|
||||
<details open>
|
||||
<summary> Manual installation </summary>
|
||||
If you don't want to use the provided script, download the binary directly from the URL for your specific OS:
|
||||
|
||||
```bash
|
||||
curl -sf -L https://download.daytona.io/daytona/latest/daytona-darwin-amd64 -o daytona
|
||||
curl -sf -L https://download.daytona.io/daytona/latest/daytona-darwin-arm64 -o daytona
|
||||
curl -sf -L https://download.daytona.io/daytona/latest/daytona-linux-amd64 -o daytona
|
||||
curl -sf -L https://download.daytona.io/daytona/latest/daytona-linux-arm64 -o daytona
|
||||
curl -sf -L https://download.daytona.io/daytona/latest/daytona-windows-amd64.exe -o daytona
|
||||
curl -sf -L https://download.daytona.io/daytona/latest/daytona-windows-arm64.exe -o daytona
|
||||
```
|
||||
|
||||
Make sure that path where `daytona` binary is downloaded is in your system PATH.
|
||||
|
||||
</details>
|
||||
Before starting the installation script, if developing locally, ensure [Docker](https://www.docker.com/products/docker-desktop/) is installed and running.
|
||||
|
||||
### Initializing Daytona
|
||||
|
||||
To initialize Daytona, follow these steps:
|
||||
|
||||
**1. Start the Daytona Server:**
|
||||
This initiates the Daytona Server in daemon mode. Use the command:
|
||||
Use this command to initiate the Daytona Server in daemon mode or use `daytona serve` to run it in the foreground:
|
||||
|
||||
```bash
|
||||
daytona server
|
||||
```
|
||||
|
||||
**2. Add Your Git Provider of Choice:**
|
||||
Daytona supports GitHub, GitLab, Bitbucket, Bitbucket Server, Gitea, Gitness, AWS CodeCommit, Azure DevOps and Gogs. To add them to your profile, use the command:
|
||||
**2. Register Your Git Provider of Choice:**
|
||||
Daytona supports GitHub, GitLab, Bitbucket and [more](https://www.daytona.io/docs/configuration/git-providers/#add-a-git-provider) Git Providers. Use this command to set them up:
|
||||
|
||||
```bash
|
||||
daytona git-providers add
|
||||
|
||||
daytona git-provider create
|
||||
```
|
||||
|
||||
Follow the steps provided.
|
||||
**3. Create Your First Target:** (optional)
|
||||
By default, Daytona uses the Docker provider to spin up environments on your local machine. For remote development environment setups, use the following command:
|
||||
|
||||
**3. Add Your Provider Target:**
|
||||
This step is for choosing where to deploy Development Environments. By default, Daytona includes a Docker provider to spin up environments on your local machine. For remote development environments, use the command:
|
||||
|
||||
```bash
|
||||
daytona target set
|
||||
```bash"
|
||||
daytona target create
|
||||
```
|
||||
|
||||
Following the steps this command adds SSH machines to your targets.
|
||||
|
||||
**4. Choose Your Default IDE:**
|
||||
The default setting for Daytona is VS Code locally. If you prefer, you can switch to VS Code - Browser or any IDE from the JetBrains portfolio using the command:
|
||||
**4. Choose Your IDE:**
|
||||
The default IDE for Daytona is the local VS Code installation. To switch to the Web IDE or any other IDE, use:
|
||||
|
||||
```bash
|
||||
daytona ide
|
||||
```
|
||||
|
||||
Now that you have installed and initialized Daytona, you can proceed to setting up your development environments and start coding instantly.
|
||||
Now that you have installed and initialized Daytona, you may proceed to setting up your development environments and starting to code instantly.
|
||||
|
||||
### Creating Dev Environments
|
||||
**4. Create Your First Daytona Development Environment:**
|
||||
|
||||
Creating development environments with Daytona is a straightforward process, accomplished with just one command:
|
||||
Creating development environments with Daytona is a straightforward process accomplished with just one command which prompts you for two things:
|
||||
|
||||
1. Choose the target/provider to decide where to create the dev environment.
|
||||
2. Select or type in the Git repository you wish to start off with.
|
||||
|
||||
After making your selections, press enter, and Daytona will handle the rest.
|
||||
|
||||
```bash
|
||||
daytona create
|
||||
```
|
||||
|
||||
You can add the `--no-ide` flag if you don't wish to open the IDE immediately after creating the environment.
|
||||
*You can add the `--no-ide` flag to skip opening the IDE and then use `daytona code` once you're ready to start coding. More info [here](https://www.daytona.io/docs/about/getting-started/).
|
||||
|
||||
Upon executing this command, you will be prompted with two questions:
|
||||
|
||||
1. Choose the provider to decide where to create a dev environment.
|
||||
2. Select or type the Git repository you wish to use to create a dev environment.
|
||||
|
||||
After making your selections, press enter, and Daytona will handle the rest. All that remains for you to do is to execute the following command to open your default IDE:
|
||||
**5. Manage the Daytona Server daemon:**
|
||||
|
||||
```bash
|
||||
daytona code
|
||||
daytona server [start|stop|restart]
|
||||
```
|
||||
|
||||
This command opens your development environment in your preferred IDE, allowing you to start coding instantly.
|
||||
---
|
||||
|
||||
### Stopping the Daytona Server:
|
||||
## Extend Daytona Through Providers
|
||||
|
||||
```bash
|
||||
daytona server stop
|
||||
```
|
||||
|
||||
### Restarting the Daytona Server:
|
||||
|
||||
```bash
|
||||
daytona server restart
|
||||
```
|
||||
|
||||
## How to Extend Daytona
|
||||
|
||||
Daytona offers flexibility for extension through the creation of plugins and providers.
|
||||
|
||||
### Providers
|
||||
|
||||
Daytona is designed to be infrastructure-agnostic, capable of creating and managing development environments across various platforms. Providers are the components that encapsulate the logic for provisioning compute resources on a specific target platform. They allow for the configuration of different targets within a single provider, enabling, for instance, multiple AWS profiles within an AWS provider.
|
||||
Daytona is designed to be infrastructure-agnostic, capable of creating and managing development environments across various platforms. Providers are the components that encapsulate the logic for provisioning compute resources on a specific platform. They allow for the configuration of different target configurations thus enabling, for instance, multiple AWS profiles within an AWS provider.
|
||||
|
||||
How does it work? When executing the `daytona create` command, Daytona communicates the environment details to the selected provider, which then provisions the necessary compute resources. Once provisioned, Daytona sets up the environment on these resources, allowing the user to interact with the environment seamlessly.
|
||||
|
||||
Providers are independent projects that adhere to the Daytona Provider interface. They can be developed in nearly any major programming language. More details coming soon.
|
||||
Providers are independent projects that adhere to the Daytona Provider interface. View all currently supported providers [here](https://github.com/orgs/daytonaio/repositories?q=daytona-provider).
|
||||
|
||||
### Plugins
|
||||
## Contributing
|
||||
|
||||
Plugins enhance Daytona's core functionalities by adding new CLI commands, API methods, or services within the development environments. They offer configurable settings to tailor the plugin's behavior to the user's needs.
|
||||
|
||||
Similar to providers, plugins are independent projects that conform to the Daytona Plugin interface and can be developed in a wide range of programming languages. More details coming soon.
|
||||
|
||||
## Contributing To Daytona
|
||||
|
||||
We welcome contributions to Daytona! Whether you're fixing bugs, improving documentation, suggesting new features, or reporting issues, your help is greatly appreciated.
|
||||
|
||||
### Open Source Licensing
|
||||
|
||||
Daytona is Open Source under the [Apache License 2.0](LICENSE), and is the [copyright of its contributors](NOTICE).
|
||||
|
||||
If you would like to contribute to the software, you must:
|
||||
|
||||
1. **Read the Developer Certificate of Origin Version 1.1**
|
||||
|
||||
Please review the [Developer Certificate of Origin Version 1.1](https://developercertificate.org/) to understand the contribution requirements.
|
||||
|
||||
2. **Sign all commits to the Daytona project**
|
||||
|
||||
Ensure that all your commits are signed to comply with the Daytona project's contribution policies.
|
||||
|
||||
This ensures that users, distributors, and other contributors can rely on all the software related to Daytona being contributed under the terms of the [Apache License 2.0](LICENSE). No contributions will be accepted without following this process.
|
||||
|
||||
### Ways to Contribute
|
||||
|
||||
### 1. Reporting Issues and Suggesting Features
|
||||
|
||||
Creating issues is a valuable way to contribute by reporting bugs, suggesting features, or improving documentation.
|
||||
|
||||
Before creating a new issue, search the existing issues [here](https://github.com/daytonaio/daytona/issues) to see if your concern has already been addressed.
|
||||
|
||||
- If no existing issue matches your contribution, follow these steps:
|
||||
1. **Identify the Type of Issue**
|
||||
- **Bug Report:** If you encounter unexpected behavior or errors.
|
||||
- **Feature Request:** If you have an idea for a new feature or improvement.
|
||||
- **Documentation Improvement:** If you notice gaps or areas for improvement in the documentation.
|
||||
1. **Create a new issue**
|
||||
- Navigate to Issues: Go to the Issues tab [here](https://github.com/daytonaio/daytona/issues).
|
||||
- Click on "New Issue": Choose the appropriate template (Bug Report, Feature Request, etc.) if available.
|
||||
- Fill Out the Issue Template: Provide a clear and concise description of the issue, including steps to reproduce (for bugs) or detailed feature descriptions.
|
||||
- Submit the Issue: Click "Submit new issue" to create the issue.
|
||||
1. **Engage with the Community**
|
||||
- **Respond to Feedback:** Be prepared to provide additional information or clarification if maintainers or other contributors have questions.
|
||||
- **Collaborate on Solutions:** If you have ideas for resolving the issue, share them in the comments.
|
||||
|
||||
### 2. Contributing Code
|
||||
|
||||
If you're interested in contributing code to Daytona, follow these steps:
|
||||
|
||||
1. **Fork the Daytona repository**
|
||||
|
||||
[Fork](https://github.com/daytonaio/daytona/fork) the GitHub repository to create your own copy of the repository.
|
||||
|
||||
1. **Add a GitHub provider (if not already registered)**
|
||||
Before creating your workspace, ensure that you have a GitHub provider registered. If not, run:
|
||||
|
||||
```bash
|
||||
daytona git-provider create
|
||||
```
|
||||
|
||||
1. **Create a Workspace with Daytona**
|
||||
|
||||
Use the Daytona CLI to create a workspace for your forked repository. Replace YOUR-FORK-URL with the URL of your forked repository.
|
||||
|
||||
```bash
|
||||
daytona create YOUR-FORK-URL
|
||||
```
|
||||
|
||||
1. **Create a new branch**
|
||||
|
||||
Once in the development container, create a new branch for your changes:
|
||||
|
||||
```bash
|
||||
git checkout -b my-new-feature
|
||||
```
|
||||
|
||||
1. **Running Daytona in development mode**
|
||||
A `dtn` alias is automatically created inside the Workspace. You can use it to compile and run daytona.
|
||||
For example:
|
||||
|
||||
```bash
|
||||
dtn serve
|
||||
```
|
||||
|
||||
1. **Make changes to the project**
|
||||
|
||||
Prepare your changes and ensure your commits are descriptive. The document contains an optional commit template, if desired.
|
||||
|
||||
1. **Test your changes**
|
||||
|
||||
Ensure to test your changes by running the project locally.
|
||||
Run the following command in the daytona root directory to run the tests:
|
||||
|
||||
```bash
|
||||
go test ./...
|
||||
```
|
||||
|
||||
1. **Generate docs**
|
||||
|
||||
Ensure to generate new docs after making command related changes, by running ./hack/generate-cli-docs.sh in the daytona root directory.
|
||||
|
||||
```bash
|
||||
./hack/generate-cli-docs.sh
|
||||
```
|
||||
|
||||
1. **Generate new API client**
|
||||
|
||||
Ensure to generate a new API client after making changes related to the API spec.
|
||||
Run the following command in the daytona root directory:
|
||||
|
||||
```bash
|
||||
./hack/swagger.sh
|
||||
```
|
||||
|
||||
1. **Check for lint errors**
|
||||
|
||||
Ensure that you have no lint errors. We use golangci-lint as our linter which is automatically installed.
|
||||
Run the following command in the daytona root directory to check for linting errors:
|
||||
|
||||
```bash
|
||||
golangci-lint run
|
||||
```
|
||||
|
||||
1. **Sign off on your commits**
|
||||
|
||||
Ensure that you sign off on all your commits to comply with the DCO v1.1. We have more details in [Prepare your changes](https://github.com/daytonaio/daytona/blob/main/PREPARING_YOUR_CHANGES.md).
|
||||
|
||||
To sign off on your Git commits more easily, you can use the -s or --signoff option when making a commit. This adds a "Signed-off-by" line to your commit message automatically, which is required to comply with the DCO v1.1.
|
||||
|
||||
Here's how you can do it:
|
||||
|
||||
```bash
|
||||
git commit -s -m "Your commit message"
|
||||
```
|
||||
|
||||
This command adds the necessary sign-off to your commit without needing to rebase later.
|
||||
|
||||
If you've already made commits without the sign-off, you can add it retrospectively by rebasing:
|
||||
|
||||
```bash
|
||||
git rebase HEAD~1 --signoff
|
||||
git push --force-with-lease origin my-new-feature
|
||||
```
|
||||
|
||||
1. **Push your changes and create a pull request**
|
||||
|
||||
Push your changes to your forked repository and create a pull request from your branch in your forked repository to the main Daytona repository.
|
||||
If you're new to GitHub, read about [pull requests](https://help.github.com/articles/about-pull-requests/). You are welcome to submit your pull request for commentary or review before it is complete by creating a [draft pull request](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests). Please include specific questions or items you'd like feedback on.
|
||||
|
||||
1. **Wait for review**
|
||||
|
||||
A Daytona team member will take a look at your PR and either merge, comment, and/or assign someone for review.
|
||||
|
||||
## License
|
||||
|
||||
This repository contains Daytona, covered under the [Apache License 2.0](LICENSE), except where noted (any Daytona logos or trademarks are not covered under the Apache License, and should be explicitly noted by a LICENSE file.)
|
||||
|
||||
Daytona is a product produced from this open source software, exclusively by Daytona Platforms, Inc. It is distributed under our commercial terms.
|
||||
|
||||
Others are allowed to make their own distribution of the software, but they cannot use any of the Daytona trademarks, cloud services, etc.
|
||||
|
||||
We explicitly grant permission for you to make a build that includes our trademarks while developing Daytona itself. You may not publish or share the build, and you may not use that build to run Daytona for any other purpose.
|
||||
|
||||
You can read more in our [packinging guidelines](PACKAGING.md).
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
This project has adapted the Code of Conduct from the [Contributor Covenant](https://www.contributor-covenant.org/). For more information see the [Code of Conduct](CODE_OF_CONDUCT.md) or contact [codeofconduct@daytona.io.](mailto:codeofconduct@daytona.io) with any additional questions or comments.
|
||||
|
||||
## Questions
|
||||
|
||||
For more information on how to use and develop Daytona, talk to us on
|
||||
[Slack](https://go.daytona.io/slack).
|
||||
Daytona is Open Source under the [Apache License 2.0](LICENSE), and is the [copyright of its contributors](NOTICE). If you would like to contribute to the software, read the Developer Certificate of Origin Version 1.1 (https://developercertificate.org/). Afterwards, navigate to the [contributing guide](CONTRIBUTING.md) to get started.
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 438 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 420 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 95 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 1.2 MiB After Width: | Height: | Size: 7.3 MiB |
Binary file not shown.
|
Before Width: | Height: | Size: 392 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 181 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 476 KiB |
Reference in New Issue
Block a user