Skip to content

Commit 658bb72

Browse files
committed
update docs
1 parent cf6894b commit 658bb72

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

content/en/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,10 @@ blocks:
8080
url: http://github.com/harmonydata/harmony
8181
- text: Google Colab notebook
8282
url: https://colab.research.google.com/github/harmonydata/harmony/blob/main/Harmony_example_walkthrough.ipynb
83+
- text: Windows installation video
84+
url: https://www.youtube.com/watch?v=Okk8tUMDr6g
85+
- text: Linux (Ubuntu) installation video
86+
url: https://www.youtube.com/watch?v=enWh0-4I0Sg
8387
code: |
8488
```vshell
8589
pip install harmonydata

content/en/developer-guide.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Developer guide
44

55
If you're a researcher and you found Harmony useful for your research, please [cite us](/ai-in-mental-health/bmc-psychiatry-paper/). If you encounter a problem, a bug, or a feature which you would like us to implement, please [raise an issue on Github](https://github.com/harmonydata/harmony) or [message us on Discord](https://discord.gg/harmonydata).
66

7-
# Git and GitHub workflow
7+
## Git and GitHub workflow
88

99
The preferred workflow for contributing to Harmony’s repository is to fork the [main repository](https://github.com/harmonydata/harmony/) on GitHub, clone, and develop on a new branch.
1010

@@ -19,6 +19,21 @@ We have four main repositories on Github under the `harmonydata` organisation:
1919

2020
This contributor guide focuses on the Python library, but you could follow the same steps for the other repositories.
2121

22+
## Testing what you've done
23+
24+
After you've made a change, please run the unit tests in any part of the code base that your changes might have affected, either directly or indirectly, to see if anything is broken:
25+
26+
* the Harmony module https://github.com/harmonydata/harmony/tree/main/tests
27+
28+
* the API https://github.com/harmonydata/harmonyapi/tree/main/tests
29+
30+
Please try and run the tool e.g. front end and back end to check if you can get the tool working still with your changes:
31+
32+
* [Python on Windows installation video](https://www.youtube.com/watch?v=Okk8tUMDr6g) (only relevant if you were working on Python)
33+
* [Python on Linux (Ubuntu) installation video](https://www.youtube.com/watch?v=enWh0-4I0Sg) (only relevant if you were working on Python)
34+
* [R on Windows installation video](https://www.youtube.com/watch?v=hFqg6T_BqZc) (only relevant if you were working on R)
35+
36+
2237
## Hackathons, coding challenges and events
2338

2439
Please contribute to our [hackathons](/open-source-for-social-science/hackathon/) and [coding challenges](/doxa/) to help improve the tool. We appreciate coming to give talks at events such as [Women In Data™️](/open-source-for-social-science/women-in-data/), [AI|DL](/psychology-ai-tool/aidl-meetup/), [MethodsCon Futures](/ai-in-mental-health/harmony-at-methodscon-futures/), [Pydata](/open-source-for-social-science/pydata-meetup/), [Lifecourse](/ai-in-mental-health/harmony-at-lifecourse-seminar/), and [AI Camp](/psychology-ai-tool/aicamp-meetup/). If you run a similar meetup or community group we are willing to come and talk.

0 commit comments

Comments
 (0)