-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
150 additions
and
86 deletions.
There are no files selected for viewing
Binary file added
BIN
+2.28 MB
docs/components/personal-fda-nodes/digital-twin-safe/digital-twin-safe-no-text.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| # Contributing The Decentralized FDA (dFDA) | ||
|
|
||
| ## For Non-Technical Users: | ||
|
|
||
| 1. **Editing Documentation via GitHub's Online Editor**: | ||
| - Navigate to the file you want to edit in your forked repository on GitHub. | ||
| - Click on the pencil icon (Edit this file) in the top right corner of the file view. | ||
| - Make your changes in the editor. | ||
| - At the bottom of the page, describe your changes and click **Commit changes**. | ||
|
|
||
| 2. **Using GitHub Issues and Discussions**: | ||
| - Navigate to the **Issues** or **Discussions** tab in the main [dFDA repository](https://github.com/decentralized-fda/decentralized-fda). | ||
| - You can create a new issue/discussion or contribute to an existing one. | ||
|
|
||
| ## For Developers and Technical Users: | ||
|
|
||
| 1. **Code Contributions**: | ||
| - After cloning your fork, create a new branch for your contribution. | ||
| - Make your changes in this branch. | ||
| - Once you're done, push the branch to your fork and submit a pull request. | ||
|
|
||
| 2. **Pull Requests**: | ||
| - Make sure your code follows the project's coding standards. | ||
| - Write a clear description in your pull request explaining your changes. | ||
| - Link any relevant issues in the pull request description. | ||
|
|
||
| ## Review Process | ||
|
|
||
| 1. **Community Voting**: | ||
| - The community reviews pull requests. | ||
| - Everyone is encouraged to vote with a thumbs up (👍) or thumbs down (👎) on pull requests. | ||
| - Pull requests with more thumbs-up votes will be considered favorably. | ||
|
|
||
| 2. **Automated Merging**: | ||
| - A GitHub Action is set up to automatically merge pull requests that have a positive thumbs-up count after 24 hours. | ||
| - Make sure to address any feedback or changes requested by the community. | ||
|
|
||
| ## Final Steps | ||
|
|
||
| After your pull request is merged, your contributions will be part of the Decentralized FDA project. We encourage you to keep participating, share your experience with others, and help us grow this initiative. | ||
|
|
||
| # Other Ways to Contribute | ||
|
|
||
| If you already have organizations or project aligned with the goals of the Decentralized FDA (dFDA), you can contribute in several valuable ways. Here are some suggestions: | ||
|
|
||
| ### 1. Partnership and Collaboration | ||
| - **Integrate Existing Projects**: If your project or organization has tools, datasets, or services that align with the dFDA's objectives, consider integrating them into the dFDA ecosystem. | ||
| - **Joint Ventures**: Engage in collaborative projects that leverage the strengths of both your organization and the dFDA. | ||
| - **Data Sharing Agreements**: If you're a data silo owner, consider forming partnerships to share non-sensitive or anonymized data, respecting privacy and regulatory constraints. | ||
|
|
||
| ### 2. Data Contribution and Management | ||
| - **Contribute Data**: Share relevant data, especially if it can fill gaps in the dFDA's current dataset. This could include clinical data, research findings, or real-world health data. | ||
| - **Data Standardization**: Help in developing or adopting standards for data formatting and sharing to ensure compatibility and interoperability. | ||
| - **Data Governance**: Assist in establishing guidelines and policies for data management, privacy, and security. | ||
|
|
||
| ### 3. Technical and Knowledge Contributions | ||
| - **Develop Interoperable Solutions**: If your organization has expertise in creating healthcare software, consider developing applications or tools that are compatible with the dFDA's framework. | ||
| - **Expertise Sharing**: Offer your expertise in areas like medical research, data analysis, AI, blockchain, etc., to improve the dFDA's strategies and methodologies. | ||
| - **Documentation and Training**: Contribute to educational materials, guides, or training programs to help users understand and engage with the dFDA platform and its components. | ||
|
|
||
| ### 4. Advocacy and Community Engagement | ||
| - **Promote the Vision**: Use your organization's platform to advocate for the dFDA's goals and encourage others to participate. | ||
| - **Host Events and Workshops**: Organize events, webinars, or workshops to educate about the dFDA's mission and how others can contribute. | ||
| - **Community Building**: Help in building a community of like-minded organizations and individuals to foster a collaborative environment. | ||
|
|
||
| ### 5. Financial and Resource Support | ||
| - **Sponsorship and Funding**: Provide financial support, either through direct funding or by helping to secure grants and other forms of financial assistance. | ||
| - **Resource Allocation**: Offer resources like server space, software licenses, or access to professional networks that can assist the dFDA project. | ||
|
|
||
| ### 6. Policy and Regulatory Guidance | ||
| - **Regulatory Expertise**: Offer guidance on navigating the complex regulatory landscapes related to healthcare data and interventions. | ||
| - **Policy Development**: Assist in developing policies and best practices that promote open collaboration while ensuring compliance with legal and ethical standards. | ||
|
|
||
| ### 7. Public and Institutional Liaison | ||
| - **Liaise with Public Health Bodies**: Act as a bridge between the dFDA and public health institutions, regulatory bodies, and NGOs. | ||
| - **Stakeholder Engagement**: Engage with various stakeholders, including patients, healthcare providers, and policymakers, to ensure the dFDA's solutions meet diverse needs. | ||
|
|
||
| Collaboration, knowledge sharing, and strategic partnerships will be key to this effort. | ||
|
|
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # ✏️ Contributing to Documentation | ||
|
|
||
| A **Pull Request** (PR) is a method used on GitHub to suggest changes to a repository (a place where code is stored). It's like saying, "I've made some changes; please review them and add them to the main project if they're good." | ||
|
|
||
| When you submit a PR, you're asking the repository maintainers to review your changes and merge them into the main codebase if they agree with your modifications. | ||
|
|
||
| ## Why Submit a Pull Request? | ||
|
|
||
| - **Contribute to a Project**: If you find a typo, a bug, or see an opportunity for improvement, a pull request lets you contribute your changes. | ||
| - **Collaborate with Others**: PRs allow you to discuss your changes with project maintainers and collaborate to refine your contribution. | ||
|
|
||
| ## How to Submit a Pull Request | ||
|
|
||
| ### Step 1: Find the File You Want to Edit | ||
| - Navigate to the repository where you want to make a change. | ||
| - Find the file you want to edit. It could be a code file, a README, or any other document in the repository. | ||
|
|
||
| ### Step 2: Edit the File | ||
| - Click on the file in the repository. | ||
| - To edit the file, click the pencil icon (🖉) in the top right corner of the file view. | ||
| - Make your changes in the online editor. | ||
|
|
||
| ### Step 3: Propose Your Changes | ||
| - After making changes, scroll down to the bottom of the page. | ||
| - Enter a title and description for your changes in the provided fields. Be as clear as possible about what you changed and why. | ||
| - Click **Propose file change**. | ||
|
|
||
| ### Step 4: Create the Pull Request | ||
| - After proposing your file change, you'll be taken to a new page titled "Comparing changes". | ||
| - Review your changes to ensure they are correct. | ||
| - Click the green **Create pull request** button. | ||
| - Add any additional comments about your changes, then click **Create pull request** again. | ||
|
|
||
| ### Step 5: Wait for Review | ||
| - Once you've submitted the PR, the project maintainers will review it. | ||
| - You might receive comments or questions about your changes. | ||
| - If the maintainers approve your changes, they will merge them into the project. If not, they may ask for further modifications or explain why the changes can't be merged. |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters