Skip to content

Latest commit

 

History

History
121 lines (85 loc) · 4.64 KB

CONTRIBUTING.md

File metadata and controls

121 lines (85 loc) · 4.64 KB

Before you contribute

  • Is it necessary?
  • Does it make developing Killara easier?
  • Does it fix a bug? -> Create an issue with the steps to reproduce
  • Does it break anything? -> Run the tests
  • Does it stick to the original goal of Killara -> Distraction-free writing
  • Does it reduce the build size?
  • Does it improve the user experience?
  • Does it improve the performance?

How to contribute

Prerequisite

Name Description Notes
Visual Studio Code Code editor Workspace settings comes with the project.
Prettier Code formatter Prettier settings comes with the project.
Git Version control You may also need the GitHub CLI
Node JavaScript runtime You can use NVM to manage your node versions
Yarn Package manager for JavaScript
Tauri Framework for building desktop apps
Tauri CLI Start front-end development server and other processes

If you're having trouble with the development setup, make sure you have read the FAQ first before raising an issue.

Git

  1. Fork the repo

  2. Clone your fork

  3. Sync your local master

    3.1.

    git remote add upstream [email protected]:eungella-io/Killara.git

    3.2.

    git fetch upstream

    3.3.

    git branch --set-upstream-to=upstream/main main

    3.4.

    git pull

  4. Run locally

    4.1 Move to the project directory and install dependencies

    cd Killara
yarn install

    4.2 Run the app

    yarn run tauri dev

  5. Create a branch

    git branch issue-2 # use issue_number, replace issue-2 with appropriate branch name
git checkout issue-2

  6. Push your changes to your fork with git push

    git add .
git commit -m"Write a meaningfull commit message"
git push

  7. Create a pull request

    7.1 Use the url from the terminal

    remote: Create a pull request for 'issue-2' on GitHub by visiting:
remote:      https://github.com/........................

    7.2 If you're having problem finding the url

    a) https://github.com/eungella-io/Killara/pulls

b) Click the button 'New pull request'

c) Click the link 'compare across forks'

d) Change head repository to your fork

e) Change the branch to your branch

f) Create pull request

  8. Repeat

    git checkout main
git pull

Upgrade yarn package

yarn outdated
yarn upgrade