Skip to content

Commit

Permalink
Update readme to help orient new contributors
Browse files Browse the repository at this point in the history
  • Loading branch information
Steve Jain committed Jan 14, 2019
1 parent f517dbc commit 8da24ee
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

AsciiDoc sources for the docs hosted at <https://docs.bisq.network>.

## New Contributors

Bisq's [decentralized governance structure][3] makes documentation especially important. If you're interested in contributing:

- Take a look at [existing docs][4] to get a feel for the general approach to format, tone, and detail
- Look through our [Contributor's Checklist][5] for a background on how we work and conventions (e.g., proper git commit messages)
- Correspond with existing contributors [on Slack^] to discuss your ideas or determine where help is most needed

## Build

To build locally, run `./gradlew build` (`gradlew.bat build --project-cache-dir=../cache` on Windows) and then open `build/asciidoc/html5/index.html` in your browser.
Expand All @@ -17,3 +25,6 @@ Commits pushed to the `master` branch of this repository are automatically built

[1]: https://asciidoctor.org/docs/user-manual
[2]: https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei
[3]: https://docs.bisq.network/user-dao-intro.html
[4]: https://docs.bisq.network
[5]: https://docs.bisq.network/contributor-checklist.html

0 comments on commit 8da24ee

Please sign in to comment.