Skip to content

Latest commit

 

History

History
91 lines (58 loc) · 4.22 KB

contributing.md

File metadata and controls

91 lines (58 loc) · 4.22 KB
Raw

Contributing to this repository

Thank you for contributing to paymentpointers.org 🎉 Your contributions are essential to making this project better.

Before you begin

Table of Contents

Types of contributions

You can contribute to Payment Pointers 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.

📚 Documentation

We started to maintain public-facing documentation for Payment Pointers on paymentpointers.org. The project is new, and available documentation is currently WIP.

Working in the Paymentpointers.org repository

You can use any package manager of your choosing. A list of steps for setting up a local development environment can be found in the README.

Labels

We use labels to communicate the intention of issues and PRs.

  • documentation issues that are improvements or additions to documentation.
  • good first issue are great issues for newcomers to take on.
  • triage issues that the core team needs to assign labels to.

Some labels will be automatically assigned to PRs.

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 Payment pointers! We appreciate your time and effort in helping make Paymentpointers.org better. Join our community on Slack to connect with other contributors and stay updated on project developments.

Happy coding!