Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

59 lines (40 loc) · 2.68 KB

Contributing to React BTCPay Server Pay Button

Thank you for considering contributing to React BTCPay Server Pay Button.

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Coding Style
  4. Commit Messages
  5. Pull Request Process

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How Can I Contribute?

Reporting Bugs

  1. Check the Issues to see if your bug has already been reported. If not, create a new issue.
  2. Be as detailed as possible. Include information on how to reproduce the issue.

Suggesting Enhancements

  1. Use the Issues page to suggest new features.
  2. Please provide context as to why the feature would be beneficial.

Code Contributions

  1. Fork the repository to your GitHub account.
  2. Clone your fork locally (git clone https://github.com/2140data/react-btcpay-paybutton.git).
  3. Create a new branch (git checkout -b new-feature-branch).
  4. Make your changes.
  5. Push your changes back to your fork on GitHub (git push origin new-feature-branch).
  6. Create a new Pull Request.

Coding Style

To ensure long-term maintainability and ease of collaboration, please adhere to best practices when writing your code. This includes proper documentation, modular design, consistent naming conventions, and thorough testing. By following these guidelines, you'll make it easier for Contributors to understand, update, and build upon your work in the future.

Commit Messages

Follow these guidelines for writing commit messages:

  • Use the imperative mood ("Add feature" not "Added feature").
  • Start with a capital letter.
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
  3. You may merge the Pull Request in once you have the sign-off of at least one other developer, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Thank you again for your interest in contributing to React BTCPay Server Pay Button!