You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/developer-guide.md
+16-1Lines changed: 16 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: Developer guide
4
4
5
5
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).
6
6
7
-
# Git and GitHub workflow
7
+
##Git and GitHub workflow
8
8
9
9
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.
10
10
@@ -19,6 +19,21 @@ We have four main repositories on Github under the `harmonydata` organisation:
19
19
20
20
This contributor guide focuses on the Python library, but you could follow the same steps for the other repositories.
21
21
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
+
22
37
## Hackathons, coding challenges and events
23
38
24
39
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