Skip to content

Commit

Permalink
docs: fix linting errors for all markdown docs
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Jan 13, 2024
1 parent 4dce240 commit 92fe80c
Show file tree
Hide file tree
Showing 8 changed files with 525 additions and 270 deletions.
135 changes: 105 additions & 30 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
# 📜 Code of conduct

(The latest version can be found at <https://www.hotosm.org/code-of-conduct>)
(The latest version can be found at [https://www.hotosm.org/code-of-conduct][1]

Welcome to Humanitarian OpenStreetMap Team. HOT is committed to providing a welcoming and safe environment for people of all races, gender identities, gender expressions, sexual orientations, physical abilities, physical appearances, socio-economic backgrounds, nationalities, ages, religions, and beliefs.
Welcome to Humanitarian OpenStreetMap Team. HOT is committed to providing a
welcoming and safe environment for people of all races, gender identities,
gender expressions, sexual orientations, physical abilities, physical
appearances, socio-economic backgrounds, nationalities, ages, religions, and
beliefs.

The HOT community principles are:

- **Be friendly and patient.** Be generous and kind in both giving and accepting critique. Critique is a natural and important part of our culture. Good critiques are kind, respectful, clear, and constructive, focused on goals and requirements rather than personal preferences. You are expected to give and receive criticism with grace. Be considerate in speech and actions, and actively seek to acknowledge and respect the boundaries of fellow attendees.
- **Be friendly and patient.** Be generous and kind in both giving and accepting
critique. Critique is a natural and important part of our culture. Good
critiques are kind, respectful, clear, and constructive, focused on goals and
requirements rather than personal preferences. You are expected to give and
receive criticism with grace. Be considerate in speech and actions, and
actively seek to acknowledge and respect the boundaries of fellow attendees.

- **Be welcoming.** We strive to be a community that welcomes and supports people of all backgrounds and identities. Some examples of behavior that contributes to creating a positive environment include:
- **Be welcoming.** We strive to be a community that welcomes and supports
people of all backgrounds and identities. Some examples of behavior that
contributes to creating a positive environment include:

- Using welcoming and inclusive language.

Expand All @@ -20,64 +31,128 @@ The HOT community principles are:

- Placing collective interest before your own interest.

- **Be considerate.** Your work will be used by other people, and you in turn will depend on the work of others. Any decision you take will affect users and colleagues, and you should take those consequences into account when making decisions. Remember that we're a world-wide community, so you might not be communicating in someone else's primary language.

- **Be respectful.** Not all of us will agree all the time, but disagreement is no excuse for poor behavior and poor manners. We might all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. It’s important to remember that a community where people feel uncomfortable or threatened is not a productive one. Members of the HOT community should be respectful when dealing with other members as well as with people outside the HOT community.

- **Be careful in your word choice.** We are a global community of professionals, and we conduct ourselves professionally. Be kind to others. Do not insult or put down other participants. Harassment and other exclusionary behavior aren't acceptable. This includes, but is not limited to:
- **Be considerate.** Your work will be used by other people, and you in turn
will depend on the work of others. Any decision you take will affect users and
colleagues, and you should take those consequences into account when making
decisions. Remember that we're a world-wide community, so you might not be
communicating in someone else's primary language.

- **Be respectful.** Not all of us will agree all the time, but disagreement is
no excuse for poor behavior and poor manners. We might all experience some
frustration now and then, but we cannot allow that frustration to turn into a
personal attack. It’s important to remember that a community where people feel
uncomfortable or threatened is not a productive one. Members of the HOT
community should be respectful when dealing with other members as well as with
people outside the HOT community.

- **Be careful in your word choice.** We are a global community of
professionals, and we conduct ourselves professionally. Be kind to others. Do
not insult or put down other participants. Harassment and other exclusionary
behavior aren't acceptable. This includes, but is not limited to:

- Violent threats or language directed against another person.

- Discriminatory jokes and language.

- Posting sexually explicit or violent material.

- Posting (or threatening to post) other people's personally identifying information ("doxing").
- Posting (or threatening to post) other people's personally identifying
information ("doxing").

- Personal insults, especially those using racist or sexist terms.

- Unwelcome sexual attention.

- Advocating for, or encouraging, any of the above behavior.

- Repeated harassment of others. In general, if someone asks you to stop, then stop.

- **Assume all communications are positive.** Always remain polite, and assume good faith. It is surprisingly easy to misunderstand each other, be it online or in person, particularly in such a culturally diverse setting as ours. Misunderstandings are particularly easy to arise when we are in a rush, or otherwise distracted. Please ask clarifying questions before assuming that a communication was inappropriate.

- **When we disagree, try to understand why.** Disagreements, both social and technical, happen easily and often. It is important that we resolve such disagreements and differing views constructively. At times it can be hard to appreciate a viewpoint that contradicts your own perceptions. Instead of pushing back, try to understand where the other person is coming from, and don’t be afraid to ask questions. You can be most helpful if your own replies serve to clarify, rather than to escalate an issue. Also don’t forget that it can be easy to make mistakes, and allow for the possibility that the mistake may have been yours. When this happens it is better to resolve the issue together, and to learn from the experience together, than to place blame.

Original text courtesy of the [Speak Up! project](http://web.archive.org/web/20141109123859/http://speakup.io/coc.html).
- Repeated harassment of others. In general, if someone asks you to stop, then
stop.

- **Assume all communications are positive.** Always remain polite, and assume
good faith. It is surprisingly easy to misunderstand each other, be it online
or in person, particularly in such a culturally diverse setting as ours.
Misunderstandings are particularly easy to arise when we are in a rush, or
otherwise distracted. Please ask clarifying questions before assuming that a
communication was inappropriate.

- **When we disagree, try to understand why.** Disagreements, both social and
technical, happen easily and often. It is important that we resolve such
disagreements and differing views constructively. At times it can be hard to
appreciate a viewpoint that contradicts your own perceptions. Instead of pushing
back, try to understand where the other person is coming from, and don’t be
afraid to ask questions. You can be most helpful if your own replies serve to
clarify, rather than to escalate an issue. Also don’t forget that it can be
easy to make mistakes, and allow for the possibility that the mistake may have
been yours. When this happens it is better to resolve the issue together, and
to learn from the experience together, than to place blame.

Original text courtesy of the [Speak Up! project][1].

Further sources:

- [Ada Initiative: HOWTO design a code of conduct for your community](https://adainitiative.org/2014/02/18/howto-design-a-code-of-conduct-for-your-community/)
- [Ada Initiative: HOWTO design a code of conduct for your community][3]

- [Algorithm Club Code of Conduct](https://github.com/drtortoise/critical-algorithm-studies/blob/master/code-of-conduct.md)
- [Algorithm Club Code of Conduct][4]

- [American Red Cross GIS Team Code of Conduct](https://github.com/AmericanRedCross/team-code-of-conduct)
- [American Red Cross GIS Team Code of Conduct][5]

- [Contributor Covenant – A Code of Conduct for Open Source Projects](http://contributor-covenant.org/)
- [Contributor Covenant – A Code of Conduct for Open Source Projects][6]

- [Django Code of Conduct](https://www.djangoproject.com/conduct/)
- [Django Code of Conduct][7]

- [Mozilla Community Participation Guidelines](https://www.mozilla.org/en-US/about/governance/policies/participation/)
- [Mozilla Community Participation Guidelines][8]

- [Vox Media Code of Conduct](http://code-of-conduct.voxmedia.com/)
- [Vox Media Code of Conduct][9]

## Complaint Handling Process

As a first measure, it is preferable to work out issues directly with the people involved, or to work with other Community Members who can help you resolve the issue. This may take several forms:
As a first measure, it is preferable to work out issues directly with the people
involved, or to work with other Community Members who can help you resolve the
issue. This may take several forms:

- Talk with one another. Assume that communications are positive and that people are treating each other with respect. Cues about emotions are often lacking from digital communications. Many of our modes of digital communication tend towards brevity, which can be easier to interpret incorrectly as being negative.
- Talk with one another. Assume that communications are positive and that people
are treating each other with respect. Cues about emotions are often lacking
from digital communications. Many of our modes of digital communication tend
towards brevity, which can be easier to interpret incorrectly as being negative.

- Contact a representative of the [Community Working Group](https://www.hotosm.org/community/working-groups/), which exists to support the HOT Community. Representatives are available to discuss any concerns about behaviour within the community, or ideas to promote positive behaviours. You can email them at [[email protected]](mailto:[email protected]).
- Contact a representative of the [Community Working Group][10], which exists to
support the HOT Community. Representatives are available to discuss any
concerns about behaviour within the community, or ideas to promote positive
behaviours. You can email them at
[[email protected]](mailto:[email protected]).

- Contact a representative of the [Governance Working Group](https://www.hotosm.org/community/working-groups/), which drafted these recommendations and the CoC. Representatives are available to provide advice on particular scenarios, as well as on the processes around the CoC.
- Contact a representative of the [Governance Working Group][11], which drafted
these recommendations and the CoC. Representatives are available to provide
advice on particular scenarios, as well as on the processes around the CoC.

- Contact the HOT Chair of Voting Members.

- Contact a [HOT Board Member](https://www.hotosm.org/board). Board members are well versed in the community and its management. They can offer advice on your particular situation, and know the resources of the organization that may be available to you.
- Contact a [HOT Board Member][12]. Board members are well versed in the
community and its management. They can offer advice on your particular
situation, and know the resources of the organization that may be available to
you.

- Contact the HOT Community Partnerships Manager.

When these informal processes fail, or when a situation warrants an immediate response by HOT, you can evoke the **HOT Policy and Code of Conduct Complaint Handling Process**. This process was adopted by HOT Voting Members in 2016 to provide a more formal means of enforcement for our community standards. You start it by emailing [[email protected]](mailto:[email protected]) with a description of your complaint, your name, and the name of the offending party. All complaints will be considered confidential. The full process is described [here](https://docs.google.com/document/d/1xb-SPADtSbgwl6mAgglHMPHpknt-E7lKRoIcSbW431A/edit) .
When these informal processes fail, or when a situation warrants an immediate
response by HOT, you can evoke the
**HOT Policy and Code of Conduct Complaint Handling Process**.
This process was adopted by HOT Voting Members in 2016 to provide a more formal
means of enforcement for our community standards. You start it by emailing
[[email protected]](mailto:[email protected]) with a description of
your complaint, your name, and the name of the offending party.
All complaints will be considered confidential.
The full process is described [here][13] .

[1]: https://www.hotosm.org/code-of-conduct
[3]: https://adainitiative.org/2014/02/18/howto-design-a-code-of-conduct-for-your-community/
[4]: https://github.com/drtortoise/critical-algorithm-studies/blob/master/code-of-conduct.md
[5]: https://github.com/AmericanRedCross/team-code-of-conduct
[6]: http://contributor-covenant.org/
[7]: https://www.djangoproject.com/conduct/
[8]: https://www.mozilla.org/en-US/about/governance/policies/participation/
[9]: http://code-of-conduct.voxmedia.com/
[10]: https://www.hotosm.org/community/working-groups/
[11]: https://www.hotosm.org/community/working-groups/
[12]: https://www.hotosm.org/board
[13]: https://docs.google.com/document/d/1xb-SPADtSbgwl6mAgglHMPHpknt-E7lKRoIcSbW431A/edit
54 changes: 38 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,33 @@
## 🤗 Welcome
# 🤗 Welcome

:+1::tada: First off, We are really glad you're reading this, because we need volunteer developers to help improve the Field Mapping Tasking Manager (FMTM)! :tada::+1:
:+1::tada: First off, We are really glad you're reading this, because we need
volunteer developers to help improve the Field Mapping Tasking Manager (FMTM)!
:tada::+1:

We welcome and encourage contributors of all skill levels, and we are committed to making sure your participation is inclusive, enjoyable, and rewarding. If you have never contributed to an open source project before, we are a good place to start, and we will make sure you are supported every step of the way. If you have **any** questions, please ask!
We welcome and encourage contributors of all skill levels, and we are committed
to making sure your participation is inclusive, enjoyable, and rewarding. If
you have never contributed to an open source project before, we are a good
place to start, and we will make sure you are supported every step of the way.
If you have **any** questions, please ask!

You can see an overview of the project and the process we have gone through in developing FMTM so far in these [slides](https://docs.google.com/presentation/d/1UrBG1X4MXwVd8Ps498FDlAYvesIailjjPPJfR_B4SUs/edit#slide=id.g15c1f409958_0_0) .
You can see an overview of the project and the process we have gone through in
developing FMTM so far in these
[slides](<https://docs.google.com/presentation/d/>
1UrBG1X4MXwVd8Ps498FDlAYvesIailjjPPJfR_B4SUs/edit#slide=id.g15c1f409958_0_0)

Furthermore, there are many ways to contribute to the **Field Mapping Tasking Manager (FMTM)**, which includes:
Furthermore, there are many ways to contribute to the
**Field Mapping Tasking Manager (FMTM)**, which includes:

## Testing

Right now, we are in the process of building the prototype. We warmly welcome your input in testing and sharing your feedback. If you are also interested in coordinating a field testing session, please reach out!
Right now, we are in the process of building the prototype. We warmly welcome
your input in testing and sharing your feedback. If you are also interested in
coordinating a field testing session, please reach out!

## Code contributions

Create pull requests (PRs) for changes that you think are needed. We would really appreciate your help!
Create pull requests (PRs) for changes that you think are needed. We would
really appreciate your help!

Skills with the following would be beneficial:

Expand All @@ -25,20 +38,29 @@ Skills with the following would be beneficial:
- Docker
- CI/CD workflows

Our latest task board can be found [here](https://github.com/orgs/hotosm/projects/22).
Our latest task board can be found
[here](https://github.com/orgs/hotosm/projects/22).

## Report bugs and suggest improvements

The [issue queue](https://github.com/hotosm/fmtm/issues) is the best way to get started. There are issue templates for BUGs and FEATURES that you can use, you could also create your own. Once you have submitted an issue, it will be assigned one label from the following [label categories](https://github.com/hotosm/fmtm/labels). If you are wondering where to start, you can filter by the **good first issue label**.
The [issue queue](https://github.com/hotosm/fmtm/issues) is the best way to get
started. There are issue templates for BUGs and FEATURES that you can use, you
could also create your own. Once you have submitted an issue, it will be
assigned one label from the following
[label categories](<<https://github.com/hotosm/fmtm/labels>).
If you are wondering where to start, you can filter by the
**good first issue label**.

## :handshake: Thank you

Thank you very much in advance for your contributions!! Please ensure you refer to our **Code of Conduct**.
If you've read the guidelines, but are still not sure how to contribute on Github, please reach out to us via our Slack **#geospatial-tech-and-innovation**.
Thank you very much in advance for your contributions!! Please ensure you refer
to our **Code of Conduct**.
If you've read the guidelines, but are still not sure how to contribute on
Github, please reach out to us via our Slack **#geospatial-tech-and-innovation**.

# Code Contribution guidelines
## Code Contribution guidelines

## Workflow
### Workflow

We operate the "Fork & Pull" model explained at [About Pull
Requests](https://help.github.com/articles/about-pull-requests/)
Expand All @@ -58,7 +80,7 @@ complications with other developers. The old free software joke is
"patches are better than bug reports" is how we contribute to the
community of people involved with this project.

# If you are reporting a problem
### If you are reporting a problem

- Describe exactly what you were trying to achieve, what you did, what you
expected to happen and what did happen instead. Include relevant information
Expand All @@ -70,15 +92,15 @@ community of people involved with this project.
keeps issues small and manageable and makes it much easier to follow through
and make sure each problem is taken care of.

## Documentation
### Documentation

Project documentation should be in [Markdown
format](https://www.markdownguide.org/), and in a _docs_
subdirectory. While it is possible to use HTML in Markdown documents
for tables and images, it is prefered to use the Markdown style as
it's much easier to read.

## Coding Style
### Coding Style

Python enforces a certain amount of style due to indent levels. Unlike
C/C++, we don't have to worry about curly braces. It is prefered that
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ Its functions include:
This is pretty straightforward using [OpenPyXL](https://openpyxl.readthedocs.io/en/stable/),
though we have to be careful to keep the location within the spreadsheet
of these two items consistent.
- GeoJSON feature collections for each form (the buildings/amenities or whatever)
- GeoJSON feature collections for each form (the buildings/amenities etc)
- An App User for each form, which in turn corresponds to a single task.
When the ODK Collect app on a user's phone is configured to function as
that App User, they have access to
Expand Down
Loading

0 comments on commit 92fe80c

Please sign in to comment.