Skip to content

Latest commit

 

History

History
107 lines (63 loc) · 4.8 KB

File metadata and controls

107 lines (63 loc) · 4.8 KB

Contributing to this repository

Thank you for contributing to the Web Monetization specification. Your contributions help shape emerging web standards.

Before you begin

Types of contributions

You can contribute to the Web Monetization specification in several ways.

Discussions

Discussions are where we have conversations about the specification and the broader ecosystem.

If you have questions, new ideas, or want to explore something before opening an issue — join the discussion.

Proposals & feature requests

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.

Early feedback is encouraged before jumping into implementation.

Issues

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.

When reporting an issue, please include:

  • A clear and descriptive title
  • A detailed description of the problem
  • Links to relevant sections of the specification
  • Context or examples where possible

Pull requests

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.

The team will review your pull request as soon as possible.

Working in this repository

Specification development

The main specification source lives at specification/index.html. This file uses ReSpec, the standard tool for authoring W3C specifications.

You don't need a full development setup to contribute to the spec.

Previewing changes

Preview changes with npx serve ./specification/ (or any other static HTTP file server) and opening http://localhost:3000/index.html.

Related specifications

This repository also includes:

Formatting

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.

Versioning

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 currently lives in specification/versions/.

Website development

For website development, see here

Submitting Pull Requests

  1. Fork the repository
  2. Create a new branch from main
  3. Make your changes and commit them
  4. Open a pull request to main with a clear title and description
    • Consider using conventional commit format (e.g., feat: add new API endpoint, fix: resolve validation error)
  5. If your PR addresses an existing issue, reference it using Closes #123
  6. Be prepared to address feedback and make changes if needed

Contributor attribution (W3C requirement)

To add a contributor (other than yourself, that's automatic), mark them one per line as follows:

+@github_username

If you added a contributor by mistake, you can remove them in a comment with:

-@github_username

If you are submitting on behalf of someone else and didn't contribute directly, you can remove yourself using the same syntax.

Review Process

  • Maintainers will review your PR for clarity, correctness, and alignment with the specification
  • Please respond to feedback promptly and make any necessary changes
  • Once approved, your changes will be merged into the main branch

Thank you for contributing to Web Monetization! Join the conversation on Slack to connect with other contributors and stay up to date on developments.