Skip to content

Commit

Permalink
formatting template texts
Browse files Browse the repository at this point in the history
  • Loading branch information
wacban committed Oct 24, 2024
1 parent 62f127c commit bec1ae6
Showing 1 changed file with 21 additions and 6 deletions.
27 changes: 21 additions & 6 deletions neps/nep-0568.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ LastUpdated: 2024-10-24

## Summary

Summary

This proposal introduces a new resharding implementation and shard layout for
production networks.

Expand All @@ -25,17 +23,20 @@ Tracking, and Mem-Trie.

The primary objective of Resharding V3 is to increase chain capacity by
splitting overutilized shards. A secondary aim is to lay the groundwork for
supporting Dynamic Resharding, Instant Resharding, and Shard Merging in future
supporting Dynamic Resharding, Instant Resharding and Shard Merging in future
updates.

## Motivation

```

Check failure on line 31 in neps/nep-0568.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Fenced code blocks should have a language specified [Context: "```"]

neps/nep-0568.md:31 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
[Explain why this proposal is necessary, how it will benefit the NEAR protocol or community, and what problems it solves. Also describe why the existing protocol specification is inadequate to address the problem that this NEP solves, and what potential use cases or outcomes.]
```

## Specification

```

Check failure on line 37 in neps/nep-0568.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Fenced code blocks should have a language specified [Context: "```"]

neps/nep-0568.md:37 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
[Explain the proposal as if you were teaching it to another developer. This generally means describing the syntax and semantics, naming new concepts, and providing clear examples. The specification needs to include sufficient detail to allow interoperable implementations getting built by following only the provided specification. In cases where it is infeasible to specify all implementation details upfront, broadly describe what they are.]

```

Resharding will be scheduled in advance by the NEAR developer team. The new
shard layout will be hardcoded into the neard binary and linked to the protocol
Expand Down Expand Up @@ -88,6 +89,7 @@ post-processing, as long as the chain's view reflects a fully resharded state.

## Reference Implementation

```

Check failure on line 92 in neps/nep-0568.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Fenced code blocks should have a language specified [Context: "```"]

neps/nep-0568.md:92 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
[This technical section is required for Protocol proposals but optional for other categories. A draft implementation should demonstrate a minimal implementation that assists in understanding or implementing this proposal. Explain the design in sufficient detail that:
* Its interaction with other features is clear.
Expand All @@ -97,24 +99,31 @@ post-processing, as long as the chain's view reflects a fully resharded state.
* For protocol changes: A link to a draft PR on nearcore that shows how it can be integrated in the current code. It should at least solve the key technical challenges.
The section should return to the examples given in the previous section, and explain more fully how the detailed proposal makes those examples work.]
```

## Security Implications

```

Check failure on line 106 in neps/nep-0568.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Fenced code blocks should have a language specified [Context: "```"]

neps/nep-0568.md:106 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
[Explicitly outline any security concerns in relation to the NEP, and potential ways to resolve or mitigate them. At the very least, well-known relevant threats must be covered, e.g. person-in-the-middle, double-spend, XSS, CSRF, etc.]
```

## Alternatives

```

Check failure on line 112 in neps/nep-0568.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Fenced code blocks should have a language specified [Context: "```"]

neps/nep-0568.md:112 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
[Explain any alternative designs that were considered and the rationale for not choosing them. Why your design is superior?]
```

## Future possibilities

```

Check failure on line 118 in neps/nep-0568.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Fenced code blocks should have a language specified [Context: "```"]

neps/nep-0568.md:118 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
[Describe any natural extensions and evolutions to the NEP proposal, and how they would impact the project. Use this section as a tool to help fully consider all possible interactions with the project in your proposal. This is also a good place to "dump ideas"; if they are out of scope for the NEP but otherwise related. Note that having something written down in the future-possibilities section is not a reason to accept the current or a future NEP. Such notes should be in the section on motivation or rationale in this or subsequent NEPs. The section merely provides additional information.]


```

## Consequences

```

Check failure on line 124 in neps/nep-0568.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Fenced code blocks should have a language specified [Context: "```"]

neps/nep-0568.md:124 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
[This section describes the consequences, after applying the decision. All consequences should be summarized here, not just the "positive" ones. Record any concerns raised throughout the NEP discussion.]
```

### Positive

Expand All @@ -130,19 +139,25 @@ The section should return to the examples given in the previous section, and exp

### Backwards Compatibility

```

Check failure on line 142 in neps/nep-0568.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Fenced code blocks should have a language specified [Context: "```"]

neps/nep-0568.md:142 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
[All NEPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. Author must explain a proposes to deal with these incompatibilities. Submissions without a sufficient backwards compatibility treatise may be rejected outright.]
```

## Unresolved Issues (Optional)

```
[Explain any issues that warrant further discussion. Considerations
* What parts of the design do you expect to resolve through the NEP process before this gets merged?
* What parts of the design do you expect to resolve through the implementation of this feature before stabilization?
* What related issues do you consider out of scope for this NEP that could be addressed in the future independently of the solution that comes out of this NEP?]
```

## Changelog

```
[The changelog section provides historical context for how the NEP developed over time. Initial NEP submission should start with version 1.0.0, and all subsequent NEP extensions must follow [Semantic Versioning](https://semver.org/). Every version should have the benefits and concerns raised during the review. The author does not need to fill out this section for the initial draft. Instead, the assigned reviewers (Subject Matter Experts) should create the first version during the first technical review. After the final public call, the author should then finalize the last version of the decision context.]
```

### 1.0.0 - Initial Version

Expand Down

0 comments on commit bec1ae6

Please sign in to comment.