Skip to content

Commit b3a5071

Browse files
committed
docs: update repo url, #4494
1 parent c240216 commit b3a5071

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ is responsible for:
5959
6. Merging the new PR.
6060

6161
For an example of this process, see PRs
62-
[#3598](https://github.com/stacks-network/stacks-blockchain/pull/3598) and
63-
[#3626](https://github.com/stacks-network/stacks-blockchain/pull/3626).
62+
[#3598](https://github.com/stacks-network/stacks-core/pull/3598) and
63+
[#3626](https://github.com/stacks-network/stacks-core/pull/3626).
6464

6565

6666
### Documentation Updates
@@ -226,7 +226,7 @@ Contributions should not contain `unsafe` blocks if at all possible.
226226
## Documentation
227227

228228
* Each file must have a **copyright statement**.
229-
* Any new non-test modules should have **module-level documentation** explaining what the module does, and how it fits into the blockchain as a whole ([example](https://github.com/stacks-network/stacks-blockchain/blob/4852d6439b473e24705f14b8af637aded33cb422/testnet/stacks-node/src/neon_node.rs#L17)).
229+
* Any new non-test modules should have **module-level documentation** explaining what the module does, and how it fits into the blockchain as a whole ([example](https://github.com/stacks-network/stacks-core/blob/4852d6439b473e24705f14b8af637aded33cb422/testnet/stacks-node/src/neon_node.rs#L17)).
230230
* Any new files must have some **top-of-file documentation** that describes what the contained code does, and how it fits into the overall module.
231231

232232
Within the source files, the following **code documentation** standards are expected:
@@ -247,7 +247,7 @@ Within the source files, the following **code documentation** standards are expe
247247
handle I/O reads and writes in an "outer" function. The "outer"
248248
function only does the needful I/O and passes the data into the
249249
"inner" function. The "inner" function is often private, whereas
250-
the "outer" function is often public. For example, [`inner_try_mine_microblock` and `try_mine_microblock`](https://github.com/stacks-network/stacks-blockchain/blob/4852d6439b473e24705f14b8af637aded33cb422/testnet/stacks-node/src/neon_node.rs#L1148-L1216).
250+
the "outer" function is often public. For example, [`inner_try_mine_microblock` and `try_mine_microblock`](https://github.com/stacks-network/stacks-core/blob/4852d6439b473e24705f14b8af637aded33cb422/testnet/stacks-node/src/neon_node.rs#L1148-L1216).
251251

252252
## Refactoring
253253

@@ -281,7 +281,7 @@ Within the source files, the following **code documentation** standards are expe
281281
does not decode with the allotted resources, then no further
282282
processing may be done and the data is discarded. For an example, see
283283
how the parsing functions in the http module use `BoundReader` and
284-
`MAX_PAYLOAD_LEN` in [http.rs](https://github.com/stacks-network/stacks-blockchain/blob/4852d6439b473e24705f14b8af637aded33cb422/src/net/http.rs#L2260-L2285).
284+
`MAX_PAYLOAD_LEN` in [http.rs](https://github.com/stacks-network/stacks-core/blob/4852d6439b473e24705f14b8af637aded33cb422/src/net/http.rs#L2260-L2285).
285285

286286
* **All network input reception is time-bound.** Every piece of code that ingests data _from the network_ must impose a maximum amount of time that ingestion can take. If the data takes too long to arrive, then it must be discarded without any further processing. There is no time bound for data ingested from disk or passed as an argument; this requirement is meant by the space-bound requirement.
287287

@@ -303,7 +303,7 @@ Changes to the peer network should be deployed incrementally and tested by multi
303303

304304
Any PRs that claim to improve performance **must ship with reproducible benchmarks** that accurately measure the improvement. This data must also be reported in the PR submission.
305305

306-
For an example, see [PR #3075](https://github.com/stacks-network/stacks-blockchain/pull/3075).
306+
For an example, see [PR #3075](https://github.com/stacks-network/stacks-core/pull/3075).
307307

308308
## Error Handling
309309

@@ -597,7 +597,7 @@ Keep in mind that better variable names can reduce the need for comments, e.g.:
597597

598598
# Licensing and contributor license agreement
599599

600-
`stacks-blockchain` is released under the terms of the GPL version 3. Contributions
600+
`stacks-core` is released under the terms of the GPL version 3. Contributions
601601
that are not licensed under compatible terms will be rejected. Moreover,
602602
contributions will not be accepted unless _all_ authors accept the project's
603603
contributor license agreement.

0 commit comments

Comments
 (0)