You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repository is being used for work in the W3C Web Platform Incubator Community Group, governed by the [W3C Community License
4
-
Agreement (CLA)](http://www.w3.org/community/about/agreements/cla/). To make substantive contributions, you must join the CG.
3
+
Thank you for contributing to the Web Monetization specification. Your contributions help shape emerging web standards.
5
4
6
-
If you are not the sole contributor to a contribution (pull request), please identify all contributors in the pull request comment.
5
+
## Before you begin
6
+
7
+
- Have you read the [Code of Conduct](https://www.w3.org/policies/code-of-conduct/)?
8
+
- Check out the [existing issues](https://github.com/WICG/webmonetization/issues) and see if we [accept contributions](#types-of-contributions) for your type of issue
9
+
- (Optional) Join the Community Group and agree to the [W3C Community Contributor License Agreement (CLA)](http://www.w3.org/community/about/agreements/cla/)
10
+
11
+
## Types of contributions
12
+
13
+
You can contribute to the Web Monetization specification in several ways.
14
+
15
+
### Discussions
16
+
17
+
Discussions are where we have conversations about the specification and the broader ecosystem.
18
+
19
+
If you have questions, new ideas, or want to explore something before opening an issue — [join the discussion](https://github.com/WICG/webmonetization/discussions).
20
+
21
+
### Proposals & feature requests
22
+
23
+
If you have an idea for improving the specification or introducing new functionality, open an issue describing your proposal. Please search existing issues first to avoid duplicates, and be clear about the problem you're solving and why it matters.
24
+
25
+
Early feedback is encouraged before jumping into implementation.
26
+
27
+
### Issues
28
+
29
+
We use GitHub issues to track bugs, inconsistencies, or gaps in the specification. If you've found something that needs fixing, search open issues to see if someone else has reported the same thing. If it's new, open an issue — we'll use it to discuss the problem before any work begins.
30
+
31
+
When reporting an issue, please include:
32
+
33
+
- A clear and descriptive title
34
+
- A detailed description of the problem
35
+
- Links to relevant sections of the specification
36
+
- Context or examples where possible
37
+
38
+
### Pull requests
39
+
40
+
Feel free to fork the repository and create a pull request for changes you think you can contribute — whether small fixes or larger spec changes.
41
+
42
+
The team will review your pull request as soon as possible.
43
+
44
+
## Working in this repository
45
+
46
+
### Specification development
47
+
48
+
The main specification source lives at [`specification/index.html`](./specification/index.html). This file uses [ReSpec](https://respec.org/docs/), the standard tool for authoring W3C specifications.
49
+
50
+
You don't need a full development setup to contribute to the spec.
51
+
52
+
#### Previewing changes
53
+
54
+
Preview changes with `npx serve ./specification/` (or [any other static HTTP file server](https://gist.github.com/willurd/5720255)) and opening http://localhost:3000/index.html.
55
+
56
+
#### Related specifications
57
+
58
+
This repository also includes:
59
+
60
+
- Web Monetization flows → [`specification/flows/`](./specification/flows/)
61
+
- Browser extension API → [`specification/extensions-api/`](./specification/extensions-api/)
62
+
63
+
#### Formatting
64
+
65
+
Prettier is disabled for files under `specification/*`. W3C specifications follow a formatting style that conflicts with Prettier (for example, void elements without trailing slashes), and there is currently no clean way to align the two.
66
+
67
+
#### Versioning
68
+
69
+
This is a Community Group Draft, so iteration is expected. We only snapshot major versions of the specification — for example, the [2021-03-17 draft](./specification/versions/CG-DRAFT-web-monetization-20210317.html) currently lives in `specification/versions/`.
70
+
71
+
### Website development
72
+
73
+
For website development, [see here](https://github.com/WICG/webmonetization#get-set-up)
74
+
75
+
## Submitting Pull Requests
76
+
77
+
1.[Fork](https://github.com/WICG/webmonetization) the repository
78
+
2. Create a new branch from `main`
79
+
3. Make your changes and commit them
80
+
4. Open a pull request to `main` with a clear title and description
81
+
-**Consider using [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) format** (e.g., `feat: add new API endpoint`, `fix: resolve validation error`)
82
+
5. If your PR addresses an existing issue, reference it using `Closes #123`
83
+
6. Be prepared to address feedback and make changes if needed
84
+
85
+
**Contributor attribution (W3C requirement)**
7
86
8
87
To add a contributor (other than yourself, that's automatic), mark them one per line as follows:
9
88
@@ -17,18 +96,12 @@ If you added a contributor by mistake, you can remove them in a comment with:
17
96
-@github_username
18
97
```
19
98
20
-
If you are making a pull request on behalf of someone else but you had no part in designing the feature, you can remove yourself with the above syntax.
21
-
22
-
## Specification Development
23
-
24
-
If you are interested in making changes to the specification, set up this repository on your local machine first. You can follow the [instructions on the README](./README.md#get-set-up), but you don't necessarily need to install dependencies or set up an environment if you want to work on the specification only (and not rest of the website).
25
-
26
-
The source file for the specification document is at [specification/index.html](./specification/index.html). This is the raw ReSpec version that editors should make changes to. Documentation for ReSpec can be accessed on the [respec.org](https://respec.org/docs/).
27
-
28
-
Preview changes with `npx serve ./specification/` (or [any other static HTTP file server](https://gist.github.com/willurd/5720255)) and opening http://localhost:3000/index.html.
99
+
If you are submitting on behalf of someone else and didn't contribute directly, you can remove yourself using the same syntax.
29
100
30
-
Similar to the main specification, there are also [Web Monetization flows](./specification/flows/) and the [browser extension API](./specification/extensions-api/) implementation specifications.
101
+
### Review Process
31
102
32
-
In general, Community Group Draft Reports do not follow the same strict conventions as more mature specifications. We only archive major versions of the specification. For example, a copy of the [2021-03-17 draft report](./specification/versions/CG-DRAFT-web-monetization-20210317.html) currently lives in [specification/versions/](./specification/versions).
103
+
- Maintainers will review your PR for clarity, correctness, and alignment with the specification
104
+
- Please respond to feedback promptly and make any necessary changes
105
+
- Once approved, your changes will be merged into the main branch
33
106
34
-
Prettier is disabled on `specification/*` as it conflicts with the code format style used by W3C specifications. There is [no way](https://github.com/prettier/prettier/issues/5246) to configure Prettier to follow the [W3C recommendation](https://github.com/validator/validator/wiki/Markup-%C2%BB-Void-elements) of not using trailing slashes on void elements.
107
+
Thank you for contributing to Web Monetization! Join the conversation on [Slack](https://communityinviter.com/apps/interledger/interledger-working-groups-slack) to connect with other contributors and stay up to date on developments.
0 commit comments