Skip to content

Latest commit

 

History

History
50 lines (29 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

50 lines (29 loc) · 2.43 KB
Raw

Contributing to bitcoin-wallet-adapter

First and foremost, thank you for considering contributing to the bitcoin-wallet-adapter repository managed by Coderixx. It's people like you that make the open-source community such a fantastic place to learn, innovate, and collaborate!

How to Contribute

Reporting Bugs

  1. Begin by searching the issues to see if the problem has already been reported.
  2. If no existing issue matches, open a new issue, providing as much relevant detail as possible. If available, utilize the bug report template.

Suggesting Enhancements

  1. Search the issues to ensure your enhancement hasn't been previously suggested.
  2. If your suggestion is unique, open a new issue. Please use the feature request template when available and provide thorough context and details.

Pull Requests

  1. Before submitting, ensure any install or build dependencies are removed.
  2. Update the README.md to reflect any changes, especially new environment variables, exposed ports, or significant adjustments.
  3. Reflect version increments in example files and the README.md based on the Pull Request's content.

Styling with TailwindCSS

All styles should be implemented using TailwindCSS. When adding new styles or customizing existing ones, make appropriate modifications to the tailwind.config.js.

Note: When creating custom classes or extending existing ones, always use the "bwa_" prefix to ensure consistency and prevent conflicts.

Styleguides

Git Commit Messages

  • Frame messages in the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Constrain the first line to 72 characters or fewer.
  • Liberally reference issues and pull requests after the first line.

JavaScript Styleguide

Adhere to the standard JavaScript style guide. For consistency and clarity, make use of linting tools like ESLint.

TypeScript Styleguide

Stay consistent with the official TypeScript coding guidelines.

Recognition

Each and every contributor brings value to this repository. As a token of appreciation, contributors are acknowledged in the README or a dedicated CONTRIBUTORS file.

Your efforts to enhance our codebase are immensely appreciated. Once more, a sincere thank you for your contribution!