Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
npaton committed Mar 26, 2023
1 parent 253e4ee commit 03c2166
Show file tree
Hide file tree
Showing 11 changed files with 526 additions and 60 deletions.
22 changes: 22 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"image": "mcr.microsoft.com/devcontainers/universal:2",
"features": {
"ghcr.io/devcontainers/features/git:1": {
"ppa": true,
"version": "os-provided"
},
"ghcr.io/eitsupi/devcontainer-features/jq-likes:1": {
"jqVersion": "os-provided",
"yqVersion": "latest",
"gojqVersion": "latest"
},
"ghcr.io/dhoeric/features/act:1": {},
"ghcr.io/guiyomh/features/golangci-lint:0": {
"version": "latest"
},
"ghcr.io/enricosecondulfo/devcontainer-features/volta:1": {
"version": "latest"
},
"ghcr.io/flexwie/devcontainer-features/op:1": {}
}
}
96 changes: 96 additions & 0 deletions .github/ISSUE_TEMPLATE/bugs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
name: 🐞 Bug
description: File a bug/issue
title: "[Bug]: "
labels: ["bug"]
# assignees:
# - npaton
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: false
- type: textarea
id: version
attributes:
label: Empirica Version
description: Copy and paste the output of `empirica version` at the root
of your project.
render: text
validations:
required: false
- type: dropdown
id: oses
attributes:
label: What OS are you seeing the problem on?
multiple: true
options:
- macOS
- Linux
- Windows
- Other
- type: dropdown
id: browsers
attributes:
label: What browser are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- Other
- Does not apply
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output, from the
`empirica` command or from the browser console. This will be
automatically formatted into code, so no need for backticks.
render: shell
validations:
required: false
- type: textarea
id: other
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](./CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Slack Community Support
url: https://join.slack.com/t/empirica-ly/shared_invite/zt-1fb34yq47-YlgYUJmXJAdv7QmHsa_fdw
about: "Please ask and answer questions in our #tech-support Slack channel."
- name: Empirica Documentation
url: https://docs.empirica.ly
about: Check the Empirica documentation.
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/features.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: ⭐ Feature
description: Request a Feature
title: "[Feature]: "
labels: ["enhancement"]
# assignees:
# - npaton
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the
feature you're requesting.
options:
- label: I have searched the existing issues
required: true
- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is.
placeholder: I have an issue when...
validations:
required: false
- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen. Add any considered drawbacks..
placeholder: I would like...
validations:
required: false
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
placeholder: We could have...
validations:
required: false
- type: textarea
id: adoption
attributes:
label: Teachability, Documentation, Adoption, Migration Strategy
description: |
If you can, explain how users will be able to use this and
possibly write out a version of the docs. Maybe a screenshot or design?
Tip: You can attach images or log files by clicking this area to
highlight it and then dragging files in.
placeholder: User would...
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](./CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
23 changes: 0 additions & 23 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +0,0 @@
# Empirica build process

The Empirica CLI / libraries are built and deployed using Github Actions.

## Build versioning

The build version (e.g. v1.0.0) is based on the @empirica/core library.
The version is changed updated by the changesets library when a "Version packages" PR is merged.


## Build the `upload-empirica-cli` action

If the `upload-empirica-cli` has been changed, the action needs to be built again:

1. Go to .github folder and install packages
`$ cd .github/actions/upload-empirica-cli`
`$ npm ci`

2. Build the action file

`$ npm run build`

3. Commit the dist folder to the repo and check Github Actions result
17 changes: 17 additions & 0 deletions .github/actions/upload-empirica-cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Upload Empirica CLI

This action uploads the Empirica CLI.

## Contributing

If the `upload-empirica-cli` has been changed, the action needs to be built again:

1. Go to .github folder and install packages
`$ cd .github/actions/upload-empirica-cli`
`$ npm ci`

2. Build the action file

`$ npm run build`

3. Commit the dist folder to the repo and check Github Actions result
132 changes: 132 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

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

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
hello@empirica.ly.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
Loading

0 comments on commit 03c2166

Please sign in to comment.