Skip to content

Commit

Permalink
Meta: update repository files
Browse files Browse the repository at this point in the history
  • Loading branch information
annevk committed Sep 27, 2023
1 parent a7b2c46 commit 9b2016c
Show file tree
Hide file tree
Showing 6 changed files with 80 additions and 18 deletions.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/0-new-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: New issue
description: File a new issue against the Console Standard.
body:
- type: markdown
attributes:
value: |
Before filling out this form, please familiarize yourself with the [Code of Conduct](https://whatwg.org/code-of-conduct). You might also find the [FAQ](https://whatwg.org/faq) and [Working Mode](https://whatwg.org/working-mode) useful.
If at any point you have questions, please reach out to us on [Chat](https://whatwg.org/chat).
- type: textarea
attributes:
label: "What is the issue with the Console Standard?"
validations:
required: true
- type: markdown
attributes:
value: "Thank you for taking the time to improve the Console Standard!"
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/1-new-feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: New feature
description: Request a new feature in the Console Standard.
labels: ["addition/proposal", "needs implementer interest"]
body:
- type: markdown
attributes:
value: |
Before filling out this form, please familiarize yourself with the [Code of Conduct](https://whatwg.org/code-of-conduct), [FAQ](https://whatwg.org/faq), and [Working Mode](https://whatwg.org/working-mode). They help with setting expectations and making sure you know what is required. The FAQ ["How should I go about proposing new features to WHATWG standards?"](https://whatwg.org/faq#adding-new-features) is especially relevant.
If at any point you have questions, please reach out to us on [Chat](https://whatwg.org/chat).
- type: textarea
attributes:
label: "What problem are you trying to solve?"
validations:
required: true
- type: textarea
attributes:
label: "What solutions exist today?"
- type: textarea
attributes:
label: "How would you solve it?"
- type: textarea
attributes:
label: "Anything else?"
- type: markdown
attributes:
value: "Thank you for taking the time to improve the Console Standard!"
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Chat
url: https://whatwg.org/chat
about: Please do reach out with questions and feedback!
- name: Stack Overflow
url: https://stackoverflow.com/
about: If you're having trouble building a web page, this is not the right repository. Consider asking your question on Stack Overflow instead.
7 changes: 3 additions & 4 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,14 @@ on:
jobs:
build:
name: Build
runs-on: ubuntu-20.04
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 2
# Note: `python` will also be this version, which various scripts depend on.
- uses: actions/setup-python@v3
- uses: actions/setup-python@v4
with:
python-version: "3.10"
python-version: "3.11"
# Note: `make deploy` will do a deploy dry run on PRs.
- run: make deploy
env:
Expand Down
5 changes: 4 additions & 1 deletion PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
<!--
Thank you for contributing to the Console Standard! Please describe the change you are making and complete the checklist below if your change is not editorial.
When editing this comment after the PR is created, check that PR-Preview doesn't overwrite your changes.
If you think your PR is ready to land, please double-check that the build is passing and the checklist is complete before pinging.
-->

- [ ] At least two implementers are interested (and none opposed):
*
*
- [ ] [Tests](https://github.com/web-platform-tests/wpt) are written and can be reviewed and commented upon at:
*
* <!-- If these tests are tentative, link a PR to make them non-tentative. -->
- [ ] [Implementation bugs](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md#handling-pull-requests) are filed:
* Chromium: …
* Gecko: …
* WebKit: …
* Deno: …
* Node.js: …
- [ ] [MDN issue](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md#handling-pull-requests) is filed: …
- [ ] The top of this comment includes a [clear commit message](https://github.com/whatwg/meta/blob/main/COMMITTING.md) to use. <!-- If you created this PR from a single commit, Github copied its message. Otherwise, you need to add a commit message yourself. -->

(See [WHATWG Working Mode: Changes](https://whatwg.org/working-mode#changes) for more details.)
34 changes: 21 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,33 @@
# Console Standard
This repository hosts the [Console Standard](https://console.spec.whatwg.org/).

All web browsers, and most other JavaScript environments, have shipped some form of developer console. This standard attempts to finally define the semantics of the console APIs, in an attempt to create convergence.
## Code of conduct

A list containing some of the observed differences so far in different environments is available in [NOTES.md](NOTES.md).
We are committed to providing a friendly, safe, and welcoming environment for all. Please read and respect the [Code of Conduct](https://whatwg.org/code-of-conduct).

## Work in progress
## Contribution opportunities

This specification is still in its very early stages. It is very much a work in progress.
Folks notice minor and larger issues with the Console Standard all the time and we'd love your help fixing those. Pull requests for typographical and grammar errors are also most welcome.

## Tests
Issues labeled ["good first issue"](https://github.com/whatwg/console/labels/good%20first%20issue) are a good place to get a taste for editing the Console Standard. Note that we don't assign issues and there's no reason to ask for availability either, just provide a pull request.

Tests can be found in the `console/` directory of [web-platform-tests/wpt](https://github.com/web-platform-tests/wpt).
If you are thinking of suggesting a new feature, read through the [FAQ](https://whatwg.org/faq) and [Working Mode](https://whatwg.org/working-mode) documents to get yourself familiarized with the process.

## Contribution guidelines
We'd be happy to help you with all of this [on Chat](https://whatwg.org/chat).

For guidelines on how to build and edit the spec, see [CONTRIBUTING.md](CONTRIBUTING.md).
## Pull requests

## Merge policy
In short, change `index.bs` and submit your patch, with a [good commit message](https://github.com/whatwg/meta/blob/main/COMMITTING.md).

If you can commit to this repository, see the [WHATWG Maintainer Guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md).
Please add your name to the Acknowledgments section in your first pull request, even for trivial fixes. The names are sorted lexicographically.

## Code of conduct
To ensure your patch meets all the necessary requirements, please also see the [Contributor Guidelines](https://github.com/whatwg/meta/blob/main/CONTRIBUTING.md). Editors of the Console Standard are expected to follow the [Maintainer Guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md).

## Tests

Tests are an essential part of the standardization process and will need to be created or adjusted as changes to the standard are made. Tests for the Console Standard can be found in the `console/` directory of [`web-platform-tests/wpt`](https://github.com/web-platform-tests/wpt).

A dashboard showing the tests running against browser engines can be seen at [wpt.fyi/results/console](https://wpt.fyi/results/console).

## Building "locally"

We are committed to providing a friendly, safe, and welcoming environment for all. Please read and respect the [WHATWG Code of Conduct](https://whatwg.org/code-of-conduct).
For quick local iteration, run `make`; this will use a web service to build the standard, so that you don't have to install anything. See more in the [Contributor Guidelines](https://github.com/whatwg/meta/blob/main/CONTRIBUTING.md#building).

0 comments on commit 9b2016c

Please sign in to comment.