Skip to content

Commit 03cee83

Browse files
authored
feat(docs): Add contributing and hacking docs (#17)
# Motivation Every public Dfinity project MUST have a contributing policy. # Changes - Add a contributing policy and a HACKING file to get contributors started. # Tests N/A
1 parent 11006db commit 03cee83

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed

CONTRIBUTING.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing to the Chain Fusion Signer
2+
3+
Thank you for your interest in contributing to the Chain Fusion Signer ❤️
4+
5+
## Contributing code changes
6+
7+
If you want to contribute a feature or bug fix, please **reach out to us first** so that we can discuss feasibility and implementation strategies. You can reach out to us:
8+
9+
- on the [forum]
10+
- by opening [GitHub issues]
11+
12+
Make sure to read the [README] and [LICENSE] first. For development instructions, see the [HACKING] document.
13+
14+
## Bug reports
15+
16+
We really appreciate bug reports through [GitHub issues].
17+
18+
[GitHub issues]: https://github.com/dfinity/chain-fusion-signer/issues
19+
[forum]: https://forum.dfinity.org/
20+
[LICENSE]: LICENSE
21+
[HACKING]: HACKING.md
22+
[README]: README.md

HACKING.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Hacking
2+
3+
This document lists information useful for development and deployment purpose.
4+
5+
## Table of content
6+
7+
- [Demo](#demo)
8+
9+
## Demo
10+
11+
This repository contains the chain fusion signer itself, and also an example application with front end and back end canisters.
12+
13+
To deploy the demo:
14+
15+
```
16+
dfx start --clean --background
17+
dfx deploy
18+
```
19+
20+
You can now visit the frontend in your browser and sign messages!

0 commit comments

Comments
 (0)