[New Feature] Add web folder to support web documentation
This commit is contained in:
65
docs/website/contributing/changelogs-in-pull-requests.md
Normal file
65
docs/website/contributing/changelogs-in-pull-requests.md
Normal file
@@ -0,0 +1,65 @@
|
||||
---
|
||||
title: Changelogs in Pull Requests
|
||||
---
|
||||
|
||||
The changelog entry in your pull request serves as a sort of "tl;dr:" for your changes: do they affect Android? are these breaking changes? is something new being added?
|
||||
|
||||
Providing a changelog using a standardized format helps release coordinators write release notes. Please include a changelog as part of your pull request description. Your pull request description will be used as the commit message should the pull request get merged.
|
||||
|
||||
### Format
|
||||
|
||||
A changelog entry has the following format
|
||||
|
||||
```
|
||||
## Changelog:
|
||||
|
||||
[Category] [Type] - Message
|
||||
```
|
||||
|
||||
The "Category" field may be one of:
|
||||
|
||||
- **Android**, for changes that affect Android.
|
||||
- **iOS**, for changes that affect iOS.
|
||||
- **General**, for changes that do not fit any of the other categories.
|
||||
- **Internal**, for changes that would not be relevant to developers consuming the release notes.
|
||||
|
||||
The "Type" field may be one of:
|
||||
|
||||
- **Added**, for new features.
|
||||
- **Changed**, for changes in existing functionality.
|
||||
- **Deprecated**, for soon-to-be removed features.
|
||||
- **Removed**, for now removed features.
|
||||
- **Fixed**, for any bug fixes.
|
||||
- **Security**, in case of vulnerabilities.
|
||||
|
||||
Finally, the "Message" field may answer "what and why" on a feature level. Use this to briefly tell OpenDBM users about notable changes.
|
||||
|
||||
For more detail, see [How do I make a good changelog?](https://keepachangelog.com/en/1.0.0/#how) and [Why keep a changelog?](https://keepachangelog.com/en/1.0.0/#why)
|
||||
|
||||
### Examples
|
||||
|
||||
- `[General] [Added] - Add snapToOffsets prop to ScrollView component`
|
||||
- `[General] [Fixed] - Fix various issues in snapToInterval on ScrollView component`
|
||||
- `[iOS] [Fixed] - Fix crash in RCTImagePicker`
|
||||
|
||||
### FAQ
|
||||
|
||||
#### What if my pull request contains changes to both Android and JavaScript?
|
||||
|
||||
Use the Android category.
|
||||
|
||||
#### What if my pull request contains changes to both Android and iOS?
|
||||
|
||||
Use the General category if the change is made in a single pull request.
|
||||
|
||||
#### What if my pull request contains changes to Android, iOS, and JavaScript?
|
||||
|
||||
Use the General category if the change is made in a single pull request.
|
||||
|
||||
#### What if...?
|
||||
|
||||
Any changelog entry is better than none. If you are unsure if you have picked the right category, use the "message" field to succinctly describe your change.
|
||||
|
||||
These entries are used by the [`@rnx-kit/rn-changelog-generator`](https://github.com/microsoft/rnx-kit/tree/main/incubator/rn-changelog-generator) script to build a rough draft, which is then edited by a release coordinator.
|
||||
|
||||
Your notes will be used to add your change to the correct location in the final release notes.
|
||||
20
docs/website/contributing/code-of-conduct.md
Normal file
20
docs/website/contributing/code-of-conduct.md
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
id: code-of-conduct
|
||||
title: Code of Conduct
|
||||
---
|
||||
|
||||
Alongside the release of OpenDBM v2.0, we decided to release alongside it a code of conduct as is conventional for community-owned repositories. The code of conduct is [included with the codebase](https://github.com/AiCure/open_dbm/blob/master/CODE_OF_CONDUCT.md) when OpenDBM is downloaded but we’ve also pasted it below.
|
||||
|
||||
## Commitments
|
||||
|
||||
In adopting this Code of Conduct, we are committed to strengthening joint efforts, innovation, and the free exchange of ideas for developing, maintaining, and using open-source software. We hope to build an active and inclusive community for development of methods for measurement of health. We want all members of this community to be active participants regardless of race, gender identity, religion, creed, color, marital status, genetic information, age, nationality, or disability.
|
||||
|
||||
## Values
|
||||
|
||||
We promote values such as being audience centered, staying calm, professional, and respectful during discussions and communicating through active listening, We encourage all members to respectfully accept evaluation and disapproval, to always aim for what is best for the community, and above all respect their fellow members.
|
||||
|
||||
We do not promote any kind of harassment, aggression, or intimidation. Personal threats, attacks, stalking, vulgar language, and any kind of insulting statements will not be tolerated. We do not approve of the exchange of disrespectful language, sketches, or cartoons nor the posting of personal information (emails, etc.) without user permission.
|
||||
|
||||
## Reporting
|
||||
|
||||
To report any complaint or inappropriate behavior, we ask the users to contact the moderators at [opendbm@aicure.com](mailto:opendbm@aicure.com). Moderators of the community have the right to remove offensive content that does not align with the Code of Conduct. If the content explicitly violates the Code of Conduct, it may result in disqualification from upcoming events and being blocked from the [GitHub Organization](https://help.github.com/articles/blocking-a-user-from-your-organization/)
|
||||
14
docs/website/contributing/community-discussions.md
Normal file
14
docs/website/contributing/community-discussions.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
id: community-discussions
|
||||
title: Community Discussions
|
||||
---
|
||||
|
||||
For any and all discussions related to the use of OpenDBM, we encourage all users to host those conversations using the (as of December of 2020) new Discussions feature on Github i.e. the [Discussions](https://github.com/AiCure/open_dbm/discussions) tab on the OpenDBM Github page. While the [Issues](https://github.com/AiCure/open_dbm/issues) tab is for technical issues, we want the Discussions tab to be for everything else. Below are a couple things we want the Discussions tab to be helpful for.
|
||||
|
||||
## Discussions on variables
|
||||
|
||||
We want to foster threads in the Discussions tab that users can contribute to regarding digital biomarker variables that are clinically relevant measures in the context of individual patient populations. For example, if a user is wondering which of OpenDBM’s outputted variables are relevant to, let’s say, Major Depressive Disorder, we want them to be able to turn to a thread in the Discussions tab where they can find that information. Our team will be starting some of these threads ourselves and adding to them as we run into more literature; we encourage other users to also utilize the Discussions tab to create a central repository of such information.
|
||||
|
||||
## Experimental design
|
||||
|
||||
One of the more common types of questions we get from users of OpenDBM is about experimental design and data collection setups. As is briefly discussed in Chapter 6, the nature of the data collection paradigm and the behaviors that are relevant differ depending on the disease state and the goals of the experiment. Not to mention––we are not authorities on experimental design whatsoever. If a user has such questions, we encourage them to post them in the [Discussions](https://github.com/AiCure/open_dbm/discussions) tab. We certainly will be monitoring it and responding to any questions to the best of our ability, but we also want to allow other researchers to provide their opinions, which we feel will be just as important to take into consideration.
|
||||
22
docs/website/contributing/contributing-overview.md
Normal file
22
docs/website/contributing/contributing-overview.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
id: overview
|
||||
title: Contributing Overview
|
||||
description: How to contribute to OpenDBM
|
||||
---
|
||||
|
||||
<!-- alex disable simple simply -->
|
||||
|
||||
Thank you for your interest in contributing to OpenDBM! From commenting on and triaging issues, to reviewing and sending Pull Requests, all contributions are welcome.
|
||||
We aim to build a vibrant and inclusive [ecosystem of partners, core contributors, and community](https://github.com/AiCure/open_dbm/blob/main/ECOSYSTEM.md) that goes beyond the main OpenDBM GitHub repository.
|
||||
|
||||
The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project.
|
||||
|
||||
Contributors and people new to open source alike will find the following guides especially useful:
|
||||
|
||||
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
|
||||
- [Building Welcoming Communities](https://opensource.guide/building-community/)
|
||||
|
||||
We want to ensure that OpenDBM feels like a community of like-minded researchers and clinicians. Hence, there are a few ways we encourage users to stay involved––and why we [encourage you to join DiME, too!](https://www.dimesociety.org/)
|
||||
|
||||
Most importantly, if you’re interested in OpenDBM, star the repo and [sign up for our listserv](https://docs.google.com/forms/d/e/1FAIpQLScLrgyM08YIumzJw8dxmRaMQ4byBL3J4A90FpokDhX8-KUNZw/viewform) for all updates.
|
||||
|
||||
5
docs/website/contributing/how-to-contribute-code.md
Normal file
5
docs/website/contributing/how-to-contribute-code.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Contribute Guidelines
|
||||
---
|
||||
|
||||
With OpenDBM v2.0, we’ve also written out a simple version of [contribution guidelines,](https://github.com/AiCure/open_dbm/blob/master/CONTRIBUTING.md) available with the code base. We want to make these more detailed in the future. As we work with the first independent contributors to OpenDBM, we will be coming out with a much more robust packet of instructions for contributors. If you find the current guidelines confusing or have trouble contributing to OpenDBM, please definitely [reach out to us](mailto:opendbm@aicure.com) and we’re happy to assist.
|
||||
6
docs/website/contributing/issue-reporting.md
Normal file
6
docs/website/contributing/issue-reporting.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
id: issue-reporting
|
||||
title: Issue Reporting
|
||||
---
|
||||
|
||||
For any technical issues with using the code i.e. during installation and during use, we ask that you––instead of emailing us––bring up the issue using the Issues feature on Github i.e. in the [Issues](https://github.com/AiCure/open_dbm/issues) tab on the OpenDBM github, We have written out an [Issue template](https://github.com/AiCure/open_dbm/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) that will automatically populate when you create a new issue; we suggest you follow that template.
|
||||
12
docs/website/contributing/license-contact.md
Normal file
12
docs/website/contributing/license-contact.md
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
id: license-contact
|
||||
title: License and Contact
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
OpenDBM is published under the [AGPL v3.0 License.](https://github.com/AiCure/open_dbm/blob/master/license.txt)
|
||||
|
||||
## Contact
|
||||
|
||||
For technical issues, we ask that you use the [Issues](https://github.com/AiCure/open_dbm/issues) tab to contact us. For any general discussions, we ask that you please use the [Discussions](https://github.com/AiCure/open_dbm/discussions) tab. If you’d like to contact us privately and directly, you can email us at [opendbm@aicure.com.](mailto:opendbm@aicure.comopendbm@aicure.com)
|
||||
8
docs/website/contributing/opendbm-listserv-signup.md
Normal file
8
docs/website/contributing/opendbm-listserv-signup.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
id: opendbm-listserv-signup
|
||||
title: OpenDBM Listserv signup
|
||||
---
|
||||
|
||||
[Use this link to sign up for the OpenDBM Listserv and stay up to date on release and events.](https://docs.google.com/forms/d/e/1FAIpQLScLrgyM08YIumzJw8dxmRaMQ4byBL3J4A90FpokDhX8-KUNZw/viewform)
|
||||
|
||||
From time to time, we will be making either small updates to OpenDBM functionalities (additional variables, bug fixes, etc.) or large version releases with major additions to features (e.g., we want a future update to OpenDBM to include analysis of wearable data). We will also be hosting virtual (and hopefully one day in-person) events for the OpenDBM user community that allow for training, introduction to new functionalities, presentations on prominent projects, etc. In either of these cases, we’d like to keep the user community up to date so that they don’t miss out on these updates or events, so we do encourage you to [sign up for the listserv.](https://docs.google.com/forms/d/e/1FAIpQLScLrgyM08YIumzJw8dxmRaMQ4byBL3J4A90FpokDhX8-KUNZw/viewform)
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
id: publications-and-referencing
|
||||
title: Publications and Referencing
|
||||
---
|
||||
|
||||
As the user community grows, we hope and are anticipating scientific publications whose methods depend partially or entirely on methods compiled into OpenDBM. For the authors of those publications, we request that they reference OpenDBM in their work. We are (as of December of 2020) preparing a manuscript that can be referenced. Meanwhile, we ask that authors at the very least reference the Github repository when mentioning OpenDBM.
|
||||
|
||||
Additionally, we are hoping to maintain an up to date list of publications that have used methods from OpenDBM when reporting their findings. This live list of publications is linked to from many different places around the Github repository and this documentation, but [here is another link to it](https://docs.google.com/spreadsheets/u/2/d/1pRBWCCFMbEgZNQzm2Litm3RUQ6glwUwswrqGDePMvh0/edit#gid=0). If you are a user of OpenDBM and have used its methods in work that has either been presented at a conference or submitted to a journal, we ask that you please submit a citation of the work to us [using this form](https://forms.gle/Hb6bDL1GJvG1ByUX7) so that we may append the list of publications with your work.
|
||||
Reference in New Issue
Block a user