Skip to content

Commit

Permalink
Include markdown files from cht-core
Browse files Browse the repository at this point in the history
Moves a range of files from cht-core to this repo, particularly release notes and
community docs, so they can be more easily kept up to date.

medic/cht-core#7413
medic/cht-core#7165
  • Loading branch information
garethbowen committed Nov 23, 2021
1 parent 8f369c4 commit 190fd09
Show file tree
Hide file tree
Showing 151 changed files with 4,981 additions and 3 deletions.
60 changes: 60 additions & 0 deletions content/en/contribute/code-of-conduct.md
@@ -0,0 +1,60 @@
---
title: "Code of Conduct"
linkTitle: "Code of Conduct"
weight: 9
description: >
The Code of Conduct for the CHT community
---

All maintainers and contributors in this community are required to act according to the following Code of Conduct. These guidelines help steer our interactions and help us provide and ensure a safe environment for everyone.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the community manager at hello@medic.org. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the Contributor Covenant, [version 1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html). For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq
96 changes: 93 additions & 3 deletions content/en/contribute/code/_index.md
Expand Up @@ -6,9 +6,99 @@ description: >
How to contribute to code to the CHT
---

The Core Framework of the Community Health Toolkit is powered by people like you. Your contributions help us create open source technology for a new model of healthcare that reaches everyone.

The [Development](https://forum.communityhealthtoolkit.org/c/developement/7) section of the forum is a great place to introduce yourself and ask questions. Or you can also jump right in:
- Issues labeled [help wanted](https://github.com/medic/cht-core/issues?q=is%3Aopen%20is%3Aissue%20label%3A%22Help%20wanted%22) are a great place to start.
- Learn to [build and host apps]({{% ref "apps" %}}), and share your experiences
- [Share a new idea or question](https://forum.communityhealthtoolkit.org/) on our Forum

The CHT community welcomes first-time contributors and experts alike. All comments, questions, and ideas are welcome!

## Ways to contribute

### First time contributor?

Issues labeled [help wanted](https://github.com/medic/cht-core/labels/Help%20wanted) are a great place to start. Looking for other ways to help? You can also:
* Improve our [documentation](#improving-our-documentation)
* Review or add a [translation](#translations)
* Find and mark duplicate issues
* Try to reproduce issues and help with troubleshooting
* Or [share a new idea or question](https://forum.communityhealthtoolkit.org) with us!
* **Working on your first Pull Request?** Check out [How to Contribute to an Open Source Project on GitHub](https://egghead.io/lessons/javascript-introduction-to-github)

### Learn to [build and host apps]({{% ref "apps" %}}), and share your experiences

### Submitting code

**Note:** We recommend you raise an issue on Github or start a conversation on our [Community Forum](https://forum.communityhealthtoolkit.org) about the change you want to make before you start on code.

1. Read our [Development Workflow]({{% ref "workflow" %}}) to understand how we work, and review our [Code Style Guide]({{% ref "style-guide" %}}) before you begin.
2. Before you submit a pull request, please make sure your contribution passes all tests. Test failures need to be addressed before we can merge your contribution.
3. Provide detail about the issue you are solving in the pull request description. Note: If your pull request addresses a specific issue, please reference it using medic/<repo>#<issue number>
4. Our CI will automatically schedule a build; monitor the build to ensure it passes.
5. Your PR will be reviewed by one of the repository's maintainers. Most PRs have at least one change requested before they're merged so don't be offended if your change doesn't get accepted on the first try!

### Improving our documentation

**Note:** [cht-docs](https://github.com/medic/cht-docs) does not involve release management and acceptance testing. Help us maintain the quality of our documentation by submitting a pull request (PR) with any suggested changes.

Is our documentation up to date? Have we covered everything we should? Could our wording be improved? Read our [Documentation Style Guide]({{% ref "contribute/docs/style-guide" %}}) then open a pull request with your suggested changes or additions.
Want to talk about Documentation generally? Join our [Community Forum](https://forum.communityhealthtoolkit.org)!

### Translations

If you are a translator but not a developer, we understand that you may need extra help to follow the [process of translating]({{% ref "apps/reference/translations" %}}) software for the first time. If that is the case, please open an issue on the GitHub repo or start a topic on the community forum.

### Disclosing vulnerabilities

We take the security of our systems seriously, and we value the security community. The disclosure of security vulnerabilities helps us ensure the security and privacy of our users.

#### Guidelines

We require that all researchers:

- Make every effort to avoid privacy violations, degradation of user experience, disruption to production systems, and destruction of data during security testing;
- Refrain from using any in-scope compromise as a platform to probe or conduct additional research, on any other system, regardless of scope;
- Perform research only within the scope set out below;
- Use the identified communication channels to report vulnerability information to us; and
- Keep information about any vulnerabilities you've discovered confidential between yourself and Medic until all production systems have been patched.

If you follow these guidelines when reporting an issue to us, we commit to:

- Not pursue or support any legal action related to your research;
- Work with you to understand and resolve the issue quickly (including an initial confirmation of your report within 72 hours of submission);
- Recognize your contribution on our Security Researcher Hall of Fame, if you are the first to report the issue and we make a code or configuration change based on the issue.

#### Scope

- https://alpha.dev.medicmobile.org

#### Out of scope

Any services hosted by 3rd party providers and any and all other services hosted on or beneath the medicmobile.org and hopephones.org domains are excluded from scope.

In the interest of the safety of our users, staff, the Internet at large and you as a security researcher, the following test types are excluded from scope:

- Findings from physical testing such as office access (e.g. open doors, tailgating)
- Findings derived primarily from social engineering (e.g. phishing, vishing)
- Findings from applications or systems not listed in the ‘Scope' section
- UI and UX bugs and spelling mistakes
- Network level Denial of Service (DoS/DDoS) vulnerabilities

Things we do not want to receive:

- Personally identifiable information (PII)
- Any exploits or proofs-of-concept in binary format (e.g. ELF)

#### How to report a security vulnerability?

If you believe you've found a security vulnerability in one of our products or platforms please send it to us by emailing dev@medic.org. Please include the following details with your report:

- Description of the location and potential impact of the vulnerability;
- A detailed description of the steps required to reproduce the vulnerability (proof of concept source code, screenshots, and compressed screen captures are all helpful to us); and
- Your name/handle and a link for recognition in our Hall of Fame.

### Code of Conduct

All maintainers and contributors are required to act according to our [Code of Conduct]({{% ref "../code-of-conduct" %}}). Thank you for your help building a positive community and a safe environment for everyone.

#### License
The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.
2 changes: 2 additions & 0 deletions content/en/core/guides/docker-setup.md
Expand Up @@ -57,6 +57,8 @@ Open a browser to: [https://localhost](https://localhost)

You will have to click to through the SSL Security warning. Click Advanced -> Continue to site.

Read about [CHT Applications]({{< relref "apps" >}}) to build and deploy your app.

### Delete & Re-Install

Stop containers:
Expand Down

0 comments on commit 190fd09

Please sign in to comment.