Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

61 lines (41 loc) · 2.14 KB
Raw

Want to help?

We greatly appreciate your help! You will be attributed to the contributor list and from our team to yours we love you. Feel free to contrib!

Core goals

  • provide a censorship-resistant and decentralized solution to upload media files for the web 3.0
  • provide a simple and easy to use web component to upload files to IPFS without any knowledge of IPFS requirements (e.g. no need to know about the CID, etc...)
  • provide a scalable and customable solution to upload files to IPFS

Stack developpement

  • Typescript to provide strong type safety
  • Prettier to makes our code look nice and helps with Pull Requests
  • Nx Workspace to provide a professionnal workspace with packages management and build tools.
  • Nx CLI to provide a simple and easy to use CLI to interact with Nx
  • Commitizen to provide a simple and easy to use CLI to interact with Nx

Getting started

You want to get started? Follow these 3 simple steps

  • Clone repo
  • Open a terminal and cd to the project folder
  • Run npm install to install all dependencies
  • Make a new branch, see BRANCH NAMING
  • do your work...
  • pass test...
  • pull request with your branch on the dev branch / or submit small fix on the master branch. I will merge it and upd project version soon as possible.

Pull Request

For your pull request please follow this guide

Branch Name

pull request type + feature name + task

Pull request types:

  • feat = new feature
  • fix = bug fix
  • docs = added or changed documentation
  • chore = some mindless work, like reformatting
  • style = changes to the style of the code
  • refactor = code change that neither fixes a bug or adds a feature
  • test = added or changed tests
  • build = added or changed build system
  • ci = added or changed CI system

Exemple: fix-desktop-add-darkmode-support

Conventional Commits

We follow a strict convectional commits pattern: https://www.conventionalcommits.org/en/v1.0.0/

PR Feedback

We are all students in this journey of life, so please accept any critique given. We are just trying to help you out or align your code with our base perhaps. This is a difficult but important part of collaboration and team work.