Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature/#1 contributing guidelines, updated architecture diagram #3

Merged
merged 1 commit into from
May 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing Guidelines for Wiiqare's smart contract
We would greatly appreciate your contributions, ideas to improve or critical thoughts in the form of:

- Reporting bugs
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Raising and discussing concerns.

on Discord or via the Github issues.

## We Develop with Github
We use github to host code, to track issues and feature requests, as well as accept pull requests.

## Want to add some code?
We use [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for our code contribution. New branches should have
the feature/ or hotfix/ prefix, the issue number and title, for example: feature/smartcontract-code-coverage-#1
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,12 @@ On root run:
2. To start a local node: `npm run dev`
3. To compile the smart contracts: `npm run compile`
4. To execute the unit tests: `npm run test`
5. To deploy a smart contract `npx hardhat run --network localhost scripts/deployWiiQareVoucherV1.ts` (change the network option for deploying on testnet to mumbai or mainnet polygon)
5. To deploy the voucher smart contract: `npx hardhat run --network localhost scripts/deployWiiQareVoucherV1.ts` (change the network option for deploying on testnet to mumbai or mainnet polygon)

## FAQ

1. Q: Why the voucher smart contract is not upgradable.
A: We want to provide trust to our users.
2. Q: Why isn't the solution fully decentralize.
A: We had to make some compromises until users will know how to properly use a wallet. Because we are dealing with providing methods for the users to pay
for their healthcare services, ease of use and speed were our top concerns and we chose to put decentralization on the second place.
Binary file modified resources/wiiqare_architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.