Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

72 lines (49 loc) · 1.88 KB
Raw

Contributing

First off, thank you for considering contributing to aVToolz. It's people like you that make aVToolz such a great tool.

No matter how big or small, any contribution is welcome and highly appreciated.

Following are the steps to contribute to this project:

  1. Fork the repository
  2. Create a new branch
  3. Make your changes
  4. Commit your changes
  5. Push to the branch
  6. Create a new Pull Request
  7. Wait for the review
  8. Get your changes merged
  9. Celebrate your success 🎉

Development

Choose any of the below methods to start working on this project:

Develop using Devcontainers (Recommended)

Requirements

  1. VSCode
  2. Git
  3. Docker

Instructions

  1. Make sure all the requirements are installed.

  2. Clone the repository

    ```bash
git clone https://github.com/a0v0/avtoolz && cd avtoolz
```

  3. Open the repo in VSCode

  4. Install this VSCode extension: Remote - Containers

  5. Press F1 and select Dev Container: Open Folder in Container

  6. Wait for the development container to build.

  7. Run task dev in the terminal to start the development server.

Develop natively

Requirements

  1. VSCode
  2. Git
  3. Node (see .node-version to see which version to install)
  4. pnpm
  5. Taskfile

Instructions

  1. Install project dependencies

    task install

  2. Start the development server

    task run

Got a question or stuck with a problem? Ask on Github Discussions