CONTRIBUTING.md

Contributing to this repository

Thank you for contributing to Web Monetization Extension 🎉 Your contributions are essential to making this project better.

Getting Started

• Have you read the code of conduct?
• Check out the existing issues & see if we accept contributions for your type of issue.

Table of Contents

• Types of contributions
  • 🪲 Issues
  • 🛠️ Pull requests
• Working in the Web Monetization Extension repository
  • Code quality
    • Linting
    • Formatting
    • Testing
    • Language
    • CI
  • Reporting Issues
  • Submitting Pull Requests
  • Review Process

Types of contributions

You can contribute to Web Monetization Extension in several ways.

🪲 Issues

We use GitHub issues to track tasks that contributors can help with. We haven't finalized labels yet for contributors to tackle. If you want to help with work related to an issue, please comment on the issue before starting work on it.

If you've found something that needs fixing, search open issues to see if someone else has reported the same thing. If it's something new, open an issue. We'll use the issue to discuss the problem you want to fix.

🛠️ Pull requests

Feel free to fork and create a pull request on changes you think you can contribute.

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

Working in the Web Monetization Extension repository

This project uses PNPM. A list of steps for setting up a local development environment can be found in the Readme.

Code quality

All the code quality tools used in the project are installed and configured at the root.

Linting

Eslint is used for linting.

./.eslintrc.json # config
./.eslintignore # ignore file

Formatting

Prettier is used for formatting.

./.prettierrc.json # config
./.prettierignore # ignore file

Testing

Jest is used for unit and integration testing.

Language

Typescript is the chosen language.

./tsconfig.json # config

Typescript config at the root is intended to be a base config.

CI

We use GitHub actions to manage our CI pipeline.

The workflows can be found in .github/workflows

Reporting Issues

If you encounter any issues or have a feature request, please create a new issue and provide the following details:

• A clear and descriptive title.
• A detailed description of the issue, including steps to reproduce if applicable.
• Information about your environment (e.g., operating system, browser, version).
• Any relevant screenshots or error messages.

Submitting Pull Requests

1. Fork the repository.
2. Create a new branch from main.
3. Make your changes and commit them.
4. Create a pull request (PR) to main.
5. Ensure your PR includes a clear title and description following the Conventional Commits Specification.
6. If your PR addresses an issue, reference the issue in the description using Closes #123.
7. Be patient and be prepared to address feedback and make changes if needed.

Review Process

• Project maintainers will review your PR for code quality, correctness, and adherence to guidelines.
• Please respond to any feedback promptly and make necessary changes.
• Once the PR is approved, it will be merged into the main branch.

Thank you for contributing to Web Monetization Extension! We appreciate your time and effort in helping make the Extension better. Join our community on Slack to connect with other contributors and stay updated on project developments.

Happy coding!