Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
Co-authored-by: Florian Dieminger <[email protected]>
  • Loading branch information
2 people authored and LeoMcA committed Jun 25, 2024
0 parents commit 0fb69ad
Show file tree
Hide file tree
Showing 192 changed files with 891,016 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.github
.git
.vscode
.idea
mdn-observatory-webext
test
node_modules
npm-debug.log
Dockerfile
.dockerignore
.env
conf/config.json
api-examples.http
.DS_Store
.editorconfig
.gitignore
.prettierrc.json
15 changes: 15 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: "Issue report"
description: Report an unexpected problem or unintended behavior.
labels: ["needs triage"]
body:
- type: markdown
attributes:
value: |
### Before you start
**Want to fix the problem yourself?** This project is open source and we welcome fixes and improvements from the community!
↩ Check the project [CONTRIBUTING.md](../blob/main/CONTRIBUTING.md) guide to see how to get started.
---
- type: textarea
id: problem
attributes:
label: What information was incorrect, unhelpful, or incomplete?
validations:
required: true
- type: textarea
id: expected
attributes:
label: What did you expect to see?
validations:
required: true
- type: textarea
id: references
attributes:
label: Do you have any supporting links, references, or citations?
description: Link to information that helps us confirm your issue.
- type: textarea
id: more-info
attributes:
label: Do you have anything more you want to share?
description: For example, steps to reproduce, screenshots, screen recordings, or sample code.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: true
contact_links:
- name: Content or feature request
url: https://github.com/mdn/mdn/issues/new/choose
about: Propose new content for MDN Web Docs or submit a feature request using this link.
- name: MDN GitHub Discussions
url: https://github.com/orgs/mdn/discussions
about: Does the issue involve a lot of changes, or is it hard to split it into actionable tasks? Start a discussion before opening an issue.
- name: MDN Web Docs on Discourse
url: https://discourse.mozilla.org/c/mdn/learn/250
about: Need help with assessments on MDN Web Docs? We have a support community for this purpose on Discourse.
- name: Help with code
url: https://stackoverflow.com/
about: If you are stuck and need help with code, StackOverflow is a great resource.
19 changes: 19 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!-- 🙌 Thanks for contributing! Adding details below will help us to merge your PR faster. -->

### Description

<!-- ✍️ Summarize your changes in one or two sentences -->

### Motivation

<!-- ❓ Why are you making these changes and how do they help? -->

### Additional details

<!-- 🔗 Link to documentation, bug trackers, source control, or other places providing more context -->

### Related issues and pull requests

<!-- 🔨 If this fully resolves a GitHub issue, use "Fixes #123" -->
<!-- 👉 Highlight related pull requests using "Relates to #123" -->
<!-- ❗ If another pull request should be merged first, use "**Depends on:** #123" -->
54 changes: 54 additions & 0 deletions .github/settings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
repository:
# See https://github.com/apps/settings for all available settings.

# The name of the repository. Changing this will rename the repository
name: project-template

# A short description of the repository that will show up on GitHub
description: MDN Web Docs project template

# A URL with more information about the repository
homepage: https://github.com/mdn/project-template

# The branch used by default for pull requests and when the repository is cloned/viewed.
default_branch: main

# This repository is a template that others can use to start a new repository.
is_template: true

branches:
- name: main
protection:
# Required. Require at least one approving review on a pull request, before merging. Set to null to disable.
required_pull_request_reviews:
# The number of approvals required. (1-6)
required_approving_review_count: 1
# Dismiss approved reviews automatically when a new commit is pushed.
dismiss_stale_reviews: true
# Blocks merge until code owners have reviewed.
require_code_owner_reviews: true

collaborators:
- username: Rumyra
permission: admin

- username: fiji-flo
permission: admin

labels:
- name: bug
color: D41130
description: "Something that's wrong or not working as expected"
- name: chore
color: 258CD3
description: "A routine task"
- name: "good first issue"
color: 48B71D
description: "Great for newcomers to start contributing"
- name: "help wanted"
color: 2E7A10
description: "Contributions welcome"

teams:
- name: core
permission: admin
10 changes: 10 additions & 0 deletions .github/workflows/auto-merge.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: "auto-merge"
on: [pull_request_target]

jobs:
auto-merge:
uses: mdn/workflows/.github/workflows/auto-merge.yml@main
with:
target-repo: "mdn/mdn-http-observatory"
secrets:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
39 changes: 39 additions & 0 deletions .github/workflows/build-and-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# run unit tests
name: build-and-test

on:
workflow_dispatch:
push:
branches: [main, wip-andi]
pull_request:
branches: [main]

jobs:
build:
runs-on: ubuntu-latest
services:
postgres:
image: postgres:16
env:
POSTGRES_USER: observatory
POSTGRES_PASSWORD: observatory
POSTGRES_DB: observatory
ports:
- 5432:5432
options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5

steps:
- uses: actions/checkout@v4
- name: Install Node
uses: actions/setup-node@v4
with:
node-version: "20.x"
- name: Install dependencies
run: "npm install"
- name: Run tests
run: npm test
env:
PGDATABASE: observatory
PGHOST: localhost
PGUSER: observatory
PGPASSWORD: observatory
42 changes: 42 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: "CodeQL"

on:
push:
branches: []
paths-ignore:
- "**.md"
# pull_request:
# # The branches below must be a subset of the branches above
# branches: []
# paths-ignore:
# - "**.md"

jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write

strategy:
matrix:
# Add the language(s) you want to analyze here as an array of strings
# for example: ['javascript'] or ['python', 'javascript']
language: ["javascript"]

steps:
- name: Checkout repository
uses: actions/checkout@v3

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
languages: ${{ matrix.language }}

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
with:
category: "/language:${{matrix.language}}"
13 changes: 13 additions & 0 deletions .github/workflows/idle.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# This workflow is hosted at: https://github.com/mdn/workflows/blob/main/.github/workflows/idle.yml
# Docs for this workflow: https://github.com/mdn/workflows/blob/main/README.md#idle
name: "Label idle issues"

on:
schedule:
- cron: "0 8 * * *"

jobs:
mark-as-idle:
uses: mdn/workflows/.github/workflows/idle.yml@main
with:
target-repo: "mdn/mdn-http-observatory"
33 changes: 33 additions & 0 deletions .github/workflows/welcome-bot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: "AlloAllo"

on:
issues:
types:
- opened
pull_request_target:
branches:
- main
types:
- opened
- closed

jobs:
allo-allo:
uses: mdn/workflows/.github/workflows/allo-allo.yml@main
with:
target-repo: "mdn/mdn-http-observatory"
issue-welcome: >
It looks like this is your first issue. Welcome! 👋
One of the project maintainers will be with you as soon as possible. We
appreciate your patience. To safeguard the health of the project, please
take a moment to read our [code of conduct](../blob/main/CODE_OF_CONDUCT.md).
pr-welcome: >
It looks like this is your first pull request. 🎉
Thank you for your contribution! One of the project maintainers will triage
and assign the pull request for review. We appreciate your patience. To
safeguard the health of the project, please take a moment to read our
[code of conduct](../blob/main/CODE_OF_CONDUCT.md).
pr-merged: >
Congratulations on your first merged pull request. 🎉 Thank you for your contribution!
Did you know we have a [project board](https://github.com/orgs/mdn/projects/25) with high-impact contribution opportunities?
We look forward to your next contribution.
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
node_modules/
.env
conf/config.json
api-examples.http
mdn-observatory-webext/dist
.DS_Store
compare_output.txt
load-script.js
1 change: 1 addition & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
8 changes: 8 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Code of conduct

This repository is governed by Mozilla's code of conduct and etiquette guidelines.
For more details, read [Mozilla's Community Participation Guidelines](https://www.mozilla.org/about/governance/policies/participation/).

## Reporting violations

For more information on how to report violations of the Community Participation Guidelines, read the [How to report](https://www.mozilla.org/about/governance/policies/participation/reporting/) page.
Loading

0 comments on commit 0fb69ad

Please sign in to comment.