Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
83 lines (59 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

83 lines (59 loc) · 3.01 KB

Submitting Issues

Bug Reports

🐞 A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Use the GitHub issue search — Check if the issue has already been reported. If it already exists, consider leaving a comment with any extra clarifying details about your situation that might help us narrow in on the nature of the problem.

  2. Check if the issue has already been fixed — In the event that you don't have the latest, try to reproduce it using the latest changes in the master branch.

  3. Submit a clear and detailed issue — Please try to be as detailed as possible in your report. Please include the following:

    • Your environment, OS and/or browsers facing the issue
    • Steps to reproduce the issue
    • Specific errors thrown, stack trace, etc.
    • The behaviour you expect vs what it's doing

Feature Requests

💡 Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Contributing Code

👍 Good pull requests — patches, improvements, new features — are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

🙏 Please adhere to the coding conventions used throughout this monorepo (indentation, accurate comments, etc.) and any other requirements (such as test coverage).

✍️ All commits must be signed and Verified in GitHub.

Follow this process:

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/bitcore
# Navigate to the newly cloned directory
cd bitcore
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/bitpay/bitcore.git

    NOTE: If you cloned a while ago, get the latest changes from upstream:

    git checkout master
git pull upstream master

  2. Create a new feature branch (off the master branch) to contain your feature, change, or fix:

    git checkout -b <feature-branch-name>

  3. Write code and commit your changes in logical chunks.

  4. Locally merge (or rebase) the upstream master branch into your feature branch:

    git pull [--rebase] upstream master

  5. Push your feature branch up to your fork:

    git push origin <feature-branch-name>

  6. Open a Pull Request with a clear title and description from your fork to the base repository (bitpay/bitcore - master).