Skip to content
This repository has been archived by the owner on Oct 11, 2023. It is now read-only.

Latest commit

 

History

History
51 lines (36 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

51 lines (36 loc) · 2.12 KB
Raw

Welcome to the Twidge contributing guide!

First of all, thank you for spending time to contribute to the project.

To get a good overview of the project make sure to read the readme.

Prerequisites

Make sure to have these installed!

  • Rustc v1.64.0 rustup update
  • Node v18.7.0
  • Cargo v1.64.0
  • Git
  • Yarn
  • TauriCli v1.0.5 cargo install tauri-cli

Getting Started

Issues

Create a new issue

If you want a new feature to be supported by Twidge or you found a bug, first check if the issue has been already created , if not you can create a new issue

Solve an issue

Find an issue which interests you. After you implement a fix you are more than welcome to open a PR with a fix.

Fix an issue or create a new feature

  • First clone the repo using the command git clone git@github.com:VarunPotti/twidge.git
  • Then run yarn to install all the require packages
  • Run yarn dev to run twidge.
  • Fix the issue or create a new feature

Pull Request

  • Create a new pull request and ask the maintainers to take a look into the pull request.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.