Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 1.95 KB

Code Contributions

Before starting to code

Please follow these guidelines before starting to code you feature or bugfix.

  • If you want to implement a bugfix or feature request from an existing issue, please comment on that issue that you will work on it. This helps us to coordinate what needs to be done and what not.
  • If you want to implement a feature request without an existing issue, please create an issue, so we know what you are working on and discuss the feature.

Before your Pull Request

Please follow these guidelines before sending your pull request and making contributions.

  • When you submit a pull request, you agree that your code is published under the GNU General Public License
  • Please link the issue you are referring to.
  • Do not include non-free software or modules with your code.
  • Make sure your branch is up to date with the development branch before submitting your pull request.
  • Stick to a similar style of code already in the project. Please look at current code to get an idea on how to do this.
  • Follow ES6 standards in your code. Ex: Use let and const instead of var. Do not use function(response){//code} for callbacks, use (response) => {//code}.
  • Comment your code when necessary. Follow the JavaScript Documentation and Comments Standard for functions.
  • Never use "any" type.
  • Please test your code. Make sure new features works.
  • Please don't add other node-modules only when necessary.
  • In case you add a new shadcn component, please rename component's file to pascal case.

Setting up Your Environment

Make you sure you have the prerequisites listed in Tuari's website

Install Dependencies

npm install

Start dev server

npm run tauri dev