Skip to content

Commit

Permalink
restructure repo and update README
Browse files Browse the repository at this point in the history
  • Loading branch information
TheDataAreClean committed Oct 25, 2021
1 parent dfa59b8 commit f58208b
Show file tree
Hide file tree
Showing 3 changed files with 143 additions and 13 deletions.
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,36 @@
# NORAL | Tech Research
> Research around the tech to develop the NORAL project platform.
Research around the tech to develop the NORAL project platform.
## Goal
The goal of this research to identify requirements, challenges, use cases, management procedures, and tooling options to develop and build [the features](https://github.com/The-Data-for-Children-Collaborative/noral-user-research/tree/main/research/02-stakeholder-workshop/feature-feedback) from the stakeholder workshop.

## Background

## Goal
The goal of this research to identify requirements, challenges, use cases, management procedures, and tooling options to develop and build [the features](https://app.mural.co/t/projectnoral3525/m/projectnoral3525/1624851833872/0db78ee8fd65733d01eff2f0ac63d22d5085662b) from the stakeholder workshop.
You can read more about the project and other related work [here](https://github.com/The-Data-for-Children-Collaborative/noral-project).

## Contributions

## Active research
[Data Collection](https://github.com/The-Data-for-Children-Collaborative/noral-tech-research/tree/main/data-collection)
You can refer to the [contributing guidelines](_contribute/CONTRIBUTING.md) and understand how to contribute.

[Data Analysis](https://github.com/The-Data-for-Children-Collaborative/noral-tech-research/tree/main/data-analysis)
The active project to track all the research is available [here](https://github.com/orgs/The-Data-for-Children-Collaborative/projects/1).

[Information Mapping](https://github.com/The-Data-for-Children-Collaborative/noral-tech-research/tree/main/information-mapping)
## Feature Research

*[Data Stories](https://github.com/The-Data-for-Children-Collaborative/noral-tech-research/tree/main/data-stories)*
[Data Analysis](./data-analysis)

## Upcoming
[Data Collection](./data-collection)

Comparative Analysis
[Data Stories](./data-stories)

Open Access
[Information Mapping](./information-mapping)

Capacity Building
[Capacity Building](./capacity-building)

[Comparative Analysis]()

## Architecture
[Base system architecture](./system-architecture)

[Base System Architecture](./system-architecture)

## License

Expand Down
76 changes: 76 additions & 0 deletions _contribute/CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## 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.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [[email protected]](mailto:[email protected]) . 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][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
49 changes: 49 additions & 0 deletions _contribute/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Contributing

Thank you for taking the time to contribute!

The following is a set of guidelines for contributing to contribute to the `noral-platform-research` repository, created and maintained by [CivicDataLab](https://github.com/CivicDataLab) under the [The Data for Children Collaborative](https://github.com/The-Data-for-Children-Collaborative/) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

## Table of Contents

[Code of Conduct](#code-of-conduct)

[TL;DR](#tldr)

[Active Threads](#active-threads)

[Contribute](#contribute)
- Pull Requests

[Not a Contributor](#not-a-contributor)

## Code of Conduct

Our code of conduct has been inspired by [Contributor Covenant](https://www.contributor-covenant.org/). You can find the same [here](CODE-OF-CONDUCT.md).

## TL;DR

Don't do anything that you wouldn't do in a real life work space. Thank you! :)

## Active Threads

Please refer to the [Methodology](../../..#methodology) section in the project [`README.md`](https://github.com/The-Data-for-Children-Collaborative/noral-platform-research) to understand active areas of contribution.

## Contribute

You can contribute by evaluating the methodoly or the code. Improvements to both are welcome.

### Pull Requests

We are always accepting improvements through [pull requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).

## Not a Contributor

I hope you find value in the repository. Please share this as a resource with anyone you believe can benfit from this information.

## Inspiration

Thank you to the following resources for guiding our `CONTRIBUTING.md` structure:

1. [Wrangling Web Contributions: How to Build a CONTRIBUTING.md](https://mozillascience.github.io/working-open-workshop/contributing/)
2. [Contributing to Atom](https://github.com/atom/atom/blob/master/CONTRIBUTING.md)

0 comments on commit f58208b

Please sign in to comment.