Create CONTRIBUTING.md and explain LSP proposal process
#305
+84
−35
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CJ42
force-pushed
the
docs/contributes-md
branch
2 times, most recently
from
9e23f66
to
220bf56
Compare
CJ42
force-pushed
the
docs/contributes-md
branch
from
220bf56
to
284deea
Compare
JeneaVranceanu
requested changes
Nov 6, 2024
|
|
||
| This section provides guidelines for how to propose a new LSP standard **before opening a Pull Requests** to the LSP repository. | ||
|
|
||
| We recomment any new proposer to review the `LIPs/lip-1.md` document for further details on how to propose new standards, the review process and guidelines on how to propose new standards and the content it should include. |
There was a problem hiding this comment.
Suggested change
| We recomment any new proposer to review the `LIPs/lip-1.md` document for further details on how to propose new standards, the review process and guidelines on how to propose new standards and the content it should include. | |
| We recommend any new proposer to review the `LIPs/lip-1.md` document for further details on how to propose new standards, the review process and guidelines on how to propose new standards and the content it should include. |
There was a problem hiding this comment.
Also, the same phrase is used making the sentence read a little strange.
| 2. Fork the repository by clicking "Fork" in the top right. | ||
| 3. Add your LIP to your fork of the repository. There is a [template LIP here](lip-X.md). | ||
| 4. Submit a Pull Request to LUKSO's [LIPs repository](https://github.com/lukso-network/LIPs). | ||
| Anyone is welcomed to make a PR to an existing LSP for fixes related to grammar or improvements related to the descriptions of an LSP specification. |
There was a problem hiding this comment.
Suggested change
| Anyone is welcomed to make a PR to an existing LSP for fixes related to grammar or improvements related to the descriptions of an LSP specification. | |
| Anyone is welcome to make a PR to an existing LSP for fixes related to grammar or improvements related to the descriptions of an LSP specification. |
| - **Draft** -- Once the first draft has been merged, you may submit follow-up pull requests with further changes to your draft until such point as you believe the LIP to be mature and ready to proceed to the next status. An LIP in draft status must be implemented to be considered for promotion to the next status (ignore this requirement for core LIPs). | ||
| - :arrow_right: Last Call -- If agreeable, the LIP editor will assign Last Call status and set a review end date (`review-period-end`), normally 14 days later. | ||
| - :x: Last Call -- A request for Last Call status will be denied if material changes are still expected to be made to the draft. We hope that LIPs only enter Last Call once, so as to avoid unnecessary noise on the RSS feed. | ||
| - **Last Call** -- This LIP is listed and documented prominently on the https://docs.lukso.tech/ websiteå. |
There was a problem hiding this comment.
Suggested change
| - **Last Call** -- This LIP is listed and documented prominently on the https://docs.lukso.tech/ websiteå. | |
| - **Last Call** -- This LIP is listed and documented prominently on the https://docs.lukso.tech/ website. |
|
|
||
| The goal of this process is to iterate over the initial idea and refine: | ||
|
|
||
| - what the specification for the LSP should contain. |
There was a problem hiding this comment.
Not sure I get this sentence. Is it to discuss what should be specified in an LSP?
|
|
||
| One or multiple editors will manually review the first PR for a new LSP and assign it a number before merging it. | ||
|
|
||
| When you believe your LIP is mature and ready to progress past the draft phase, you should do open a PR changing the state of your LIP to 'Final'. An editor will review your draft and ask if anyone objects to its being finalised. If the editor decides there is no rough consensus - for instance, because contributors point out significant issues with the LIP - they may close the PR and request that you fix the issues in the draft before trying again. |
There was a problem hiding this comment.
Suggested change
| When you believe your LIP is mature and ready to progress past the draft phase, you should do open a PR changing the state of your LIP to 'Final'. An editor will review your draft and ask if anyone objects to its being finalised. If the editor decides there is no rough consensus - for instance, because contributors point out significant issues with the LIP - they may close the PR and request that you fix the issues in the draft before trying again. | |
| When you believe your LIP is mature and ready to progress past the draft phase, you should do open a PR changing the state of your LIP to 'Final'. An editor will review your draft and ask if anyone objects to it being finalised. If the editor decides there is no rough consensus - for instance, because contributors point out significant issues with the LIP - they may close the PR and request that you fix the issues in the draft before trying again. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.