Skip to content

Commit

Permalink
Merge branch 'format' of github.com:MicahMaphet/bitcore
Browse files Browse the repository at this point in the history
  • Loading branch information
kajoseph committed Aug 5, 2024
2 parents ce4a229 + 9e84d79 commit 35b6f07
Show file tree
Hide file tree
Showing 4 changed files with 104 additions and 104 deletions.
172 changes: 86 additions & 86 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -1,86 +1,86 @@
# 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 are 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).

Follow this process:

1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
and configure the remotes:

```bash
# 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
```

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

```bash
git checkout master
git pull upstream master
```

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

```bash
git checkout -b <feature-branch-name>
```

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

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

```bash
git pull [--rebase] upstream master
```

6. Push your feature branch up to your fork:

```bash
git push origin <feature-branch-name>
```

7. [Open a Merge Request](https://help.github.com/articles/using-pull-requests/)
with a clear title and description from your fork to the base repository (bitpay/bitcore - master).


# 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** &mdash; 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** &mdash; 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** &mdash; 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).

Follow this process:

1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
and configure the remotes:

```bash
# 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
```

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

```bash
git checkout master
git pull upstream master
```

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

```bash
git checkout -b <feature-branch-name>
```

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

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

```bash
git pull [--rebase] upstream master
```

6. Push your feature branch up to your fork:

```bash
git push origin <feature-branch-name>
```

7. [Open a Merge Request](https://help.github.com/articles/using-pull-requests/)
with a clear title and description from your fork to the base repository (bitpay/bitcore - master).


2 changes: 1 addition & 1 deletion packages/bitcore-lib/docs/address.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Represents a bitcoin address. Addresses are the most popular way to make bitcoin

## Instantiate an Address

To be able to receive bitcoins an address is needed, but in order to spend them a private key is necessary. Please take a look at the [`PrivateKey`](privatekey.md) docs for more information about exporting and saving a key.
To be able to receive bitcoins, an address is needed, but in order to spend them a private key is necessary. Please take a look at the [`PrivateKey`](privatekey.md) docs for more information about exporting and saving a key.

```javascript
var privateKey = new PrivateKey();
Expand Down
28 changes: 14 additions & 14 deletions packages/bitcore-node/src/decorators/decorators.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
export function historical(_target: any, _propertyKey: string | symbol, descriptor: PropertyDescriptor) {
descriptor.value.category = 'archive';
}

export function realtime(_target: any, _propertyKey: string | symbol, descriptor: PropertyDescriptor) {
descriptor.value.category = 'realtime';
}

export function internal( _target: any, _propertyKey: string | symbol, descriptor: PropertyDescriptor) {
descriptor.value.scope = 'internal';
}

export function external(_target: any, _propertyKey: string | symbol, descriptor: PropertyDescriptor) {
descriptor.value.scope = 'external';
export function historical(_target: any, _propertyKey: string | symbol, descriptor: PropertyDescriptor) {
descriptor.value.category = 'archive';
}

export function realtime(_target: any, _propertyKey: string | symbol, descriptor: PropertyDescriptor) {
descriptor.value.category = 'realtime';
}

export function internal(_target: any, _propertyKey: string | symbol, descriptor: PropertyDescriptor) {
descriptor.value.scope = 'internal';
}

export function external(_target: any, _propertyKey: string | symbol, descriptor: PropertyDescriptor) {
descriptor.value.scope = 'external';
}
6 changes: 3 additions & 3 deletions packages/bitcore-node/src/modules/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import _ from 'lodash';

import Logger from '../logger';
import logger from '../logger';
import { ChainStateProvider } from '../providers/chain-state';
import { Libs } from '../providers/libs';
import { Api } from '../services/api';
Expand Down Expand Up @@ -76,9 +76,9 @@ class ModuleManager extends BaseModule {
for (const chain in chains) {
const modulePath = this.KNOWN_MODULE_PATHS[chain];
if (!modulePath) {
Logger.warn(
logger.warn(
`Auto module registration failed for chain '${chain}'. ` +
'Is the chain name / module path inside of KNOWN_MODULE_PATHS?'
'Is the chain name / module path inside of KNOWN_MODULE_PATHS?'
);
continue;
}
Expand Down

0 comments on commit 35b6f07

Please sign in to comment.