/bitwallet-client

Primary LanguageTypeScriptMIT LicenseMIT

BitWallet

Description

BitWallet is a wallet built on Bitcoin, allowing one to accept and transfer value in Bitcoin. It aims to provide a user-friendly and intuitive interface to interact with the protocol.

Table of Contents

Installation

To get started with this project, follow these steps:

  1. Clone this repository: git clone git@github.com:isaack-njama/bitwallet-client.git
  2. Navigate to the project directory: cd bitwallet-client
  3. Install dependencies: npm install
  4. Start the development server: ionic serve

Contribution Guidelines

Contributions to help improve this project are welcome. To contribute, please follow these guidelines:

Reporting Bugs

If you encounter a bug while using the application, please submit a detailed bug report by following these steps:

  1. Check the existing issues to see if the bug has already been reported.
  2. If the bug has not been reported, create a new issue with a descriptive title and detailed description of the bug, including steps to reproduce it.
  3. Add appropriate labels to the issue, such as "bug" and "help wanted", if applicable.

Requesting Features

If you have a feature request or an idea for improving the application, please submit a detailed feature request by following these steps:

  1. Check the existing issues to see if the feature has already been requested.
  2. If the feature has not been requested, create a new issue with a descriptive title and detailed description of the feature request, including any relevant use cases or examples.
  3. Add appropriate labels to the issue, such as "enhancement" and "feature request".

Creating Pull Requests

If you would like to contribute code to the project, please follow these steps:

  1. Fork the repository and create a new branch from the main branch.
  2. Make your changes in the new branch, following the project's coding style and conventions.
  3. Ensure that your changes do not introduce any new issues.
  4. Commit your changes using conventional commits format. This helps maintain a clean and structured commit history.
  5. Push your branch to your forked repository.
  6. Open a pull request against the main branch of the original repository.
  7. Provide a descriptive title and detailed description for your pull request, explaining the changes you have made and any relevant information for reviewers.
  8. Add reviewers to your pull request, if applicable.
  9. Respond to any feedback or requests for changes from reviewers promptly.
  10. Once your pull request has been approved and merged, delete your branch from your forked repository.

License

This project is licensed under the MIT License