forked from sui-foundation/sips
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 19a809f
Showing
5 changed files
with
260 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.DS_Store |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
## How to contribute | ||
|
||
1. Read [SIP-1](sips/sip-1.md). | ||
1. Fork the `sips` [repository](https://github.com/sui-foundation/sips). | ||
1. Copy the [SIP template](TEMPLATE.md), using a temporary filename in the format `sips/sip-temporary_title.md`, into the `sips` directory. | ||
1. Fill in the template, ensuring you follow the comments inside. | ||
1. Assets may be embedded into the SIP. Include these assets in the `assets` directory, in a subdirectory named `sip-temporary_title`. | ||
1. Submit a Pull Request to the `sips` [repository](https://github.com/sui-foundation/sips) from your forked repository. | ||
|
||
## Next steps | ||
|
||
If your PR is correctly formulated, the status will be moved to `Draft` and a SIP number will be assigned. At this point, it has officially entered the SIP process. Continue to follow the instructions in [SIP-1](sips/sip-1.md) as your SIP makes its way through the process. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
Creative Commons Legal Code | ||
|
||
CC0 1.0 Universal | ||
|
||
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE | ||
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN | ||
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS | ||
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES | ||
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS | ||
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM | ||
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED | ||
HEREUNDER. | ||
|
||
Statement of Purpose | ||
|
||
The laws of most jurisdictions throughout the world automatically confer | ||
exclusive Copyright and Related Rights (defined below) upon the creator | ||
and subsequent owner(s) (each and all, an "owner") of an original work of | ||
authorship and/or a database (each, a "Work"). | ||
|
||
Certain owners wish to permanently relinquish those rights to a Work for | ||
the purpose of contributing to a commons of creative, cultural and | ||
scientific works ("Commons") that the public can reliably and without fear | ||
of later claims of infringement build upon, modify, incorporate in other | ||
works, reuse and redistribute as freely as possible in any form whatsoever | ||
and for any purposes, including without limitation commercial purposes. | ||
These owners may contribute to the Commons to promote the ideal of a free | ||
culture and the further production of creative, cultural and scientific | ||
works, or to gain reputation or greater distribution for their Work in | ||
part through the use and efforts of others. | ||
|
||
For these and/or other purposes and motivations, and without any | ||
expectation of additional consideration or compensation, the person | ||
associating CC0 with a Work (the "Affirmer"), to the extent that he or she | ||
is an owner of Copyright and Related Rights in the Work, voluntarily | ||
elects to apply CC0 to the Work and publicly distribute the Work under its | ||
terms, with knowledge of his or her Copyright and Related Rights in the | ||
Work and the meaning and intended legal effect of CC0 on those rights. | ||
|
||
1. Copyright and Related Rights. A Work made available under CC0 may be | ||
protected by copyright and related or neighboring rights ("Copyright and | ||
Related Rights"). Copyright and Related Rights include, but are not | ||
limited to, the following: | ||
|
||
i. the right to reproduce, adapt, distribute, perform, display, | ||
communicate, and translate a Work; | ||
ii. moral rights retained by the original author(s) and/or performer(s); | ||
iii. publicity and privacy rights pertaining to a person's image or | ||
likeness depicted in a Work; | ||
iv. rights protecting against unfair competition in regards to a Work, | ||
subject to the limitations in paragraph 4(a), below; | ||
v. rights protecting the extraction, dissemination, use and reuse of data | ||
in a Work; | ||
vi. database rights (such as those arising under Directive 96/9/EC of the | ||
European Parliament and of the Council of 11 March 1996 on the legal | ||
protection of databases, and under any national implementation | ||
thereof, including any amended or successor version of such | ||
directive); and | ||
vii. other similar, equivalent or corresponding rights throughout the | ||
world based on applicable law or treaty, and any national | ||
implementations thereof. | ||
|
||
2. Waiver. To the greatest extent permitted by, but not in contravention | ||
of, applicable law, Affirmer hereby overtly, fully, permanently, | ||
irrevocably and unconditionally waives, abandons, and surrenders all of | ||
Affirmer's Copyright and Related Rights and associated claims and causes | ||
of action, whether now known or unknown (including existing as well as | ||
future claims and causes of action), in the Work (i) in all territories | ||
worldwide, (ii) for the maximum duration provided by applicable law or | ||
treaty (including future time extensions), (iii) in any current or future | ||
medium and for any number of copies, and (iv) for any purpose whatsoever, | ||
including without limitation commercial, advertising or promotional | ||
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each | ||
member of the public at large and to the detriment of Affirmer's heirs and | ||
successors, fully intending that such Waiver shall not be subject to | ||
revocation, rescission, cancellation, termination, or any other legal or | ||
equitable action to disrupt the quiet enjoyment of the Work by the public | ||
as contemplated by Affirmer's express Statement of Purpose. | ||
|
||
3. Public License Fallback. Should any part of the Waiver for any reason | ||
be judged legally invalid or ineffective under applicable law, then the | ||
Waiver shall be preserved to the maximum extent permitted taking into | ||
account Affirmer's express Statement of Purpose. In addition, to the | ||
extent the Waiver is so judged Affirmer hereby grants to each affected | ||
person a royalty-free, non transferable, non sublicensable, non exclusive, | ||
irrevocable and unconditional license to exercise Affirmer's Copyright and | ||
Related Rights in the Work (i) in all territories worldwide, (ii) for the | ||
maximum duration provided by applicable law or treaty (including future | ||
time extensions), (iii) in any current or future medium and for any number | ||
of copies, and (iv) for any purpose whatsoever, including without | ||
limitation commercial, advertising or promotional purposes (the | ||
"License"). The License shall be deemed effective as of the date CC0 was | ||
applied by Affirmer to the Work. Should any part of the License for any | ||
reason be judged legally invalid or ineffective under applicable law, such | ||
partial invalidity or ineffectiveness shall not invalidate the remainder | ||
of the License, and in such case Affirmer hereby affirms that he or she | ||
will not (i) exercise any of his or her remaining Copyright and Related | ||
Rights in the Work or (ii) assert any associated claims and causes of | ||
action with respect to the Work, in either case contrary to Affirmer's | ||
express Statement of Purpose. | ||
|
||
4. Limitations and Disclaimers. | ||
|
||
a. No trademark or patent rights held by Affirmer are waived, abandoned, | ||
surrendered, licensed or otherwise affected by this document. | ||
b. Affirmer offers the Work as-is and makes no representations or | ||
warranties of any kind concerning the Work, express, implied, | ||
statutory or otherwise, including without limitation warranties of | ||
title, merchantability, fitness for a particular purpose, non | ||
infringement, or the absence of latent or other defects, accuracy, or | ||
the present or absence of errors, whether or not discoverable, all to | ||
the greatest extent permissible under applicable law. | ||
c. Affirmer disclaims responsibility for clearing rights of other persons | ||
that may apply to the Work or any use thereof, including without | ||
limitation any person's Copyright and Related Rights in the Work. | ||
Further, Affirmer disclaims responsibility for obtaining any necessary | ||
consents, permissions or other rights required for any use of the | ||
Work. | ||
d. Affirmer understands and acknowledges that Creative Commons is not a | ||
party to this document and has no duty or obligation with respect to | ||
this CC0 or use of the Work. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Sui Improvement Proposals (SIPs) | ||
|
||
## What is SIP? | ||
|
||
SIP stands for Sui Improvement Proposal. A SIP is a design document that details a new feature for Sui, its processes, or the ecosystem. It provides the basis for the Sui community to propose a new idea and to assess its merits, its feasability and the implementation details. | ||
|
||
## How do I create a SIP? | ||
|
||
Read the [contribution guidelines](CONTRIBUTING.md). | ||
|
||
## Where can I discuss SIPs? | ||
|
||
- Discussions on active SIPs are located at https://sips.sui.io/comments-active | ||
- Ideas for SIPs (pre-SIPs) are located at https://sips.sui.io/comments-ideas | ||
|
||
## How do I provide feedback on the SIP process? | ||
|
||
If you have comments regarding the SIP process, rather than with a specific SIP, please [raise an issue](https://github.com/sui-foundation/sips/issues/new/choose). |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
| SIP-Number | <Leave this blank; it will be assigned by a SIP Editor> | | ||
| ---: | :--- | | ||
| Title | <Must be short; maximum 64 characters> | | ||
| Description | <Must be one sentence that briefly describes the SIP; maximum 160 characters> | | ||
| Author | <A list of the authors' real names or aliases, plus either their GitHub usernames (in parentheses) or email addresses (in angle brackets)> | | ||
| Editor | <Leave this blank; it will be assigned by a SIP Editor> | | ||
| Type | <Standard, Process, Informational> | | ||
| Category | <Optional, only needed for Type=Standard; Core, Networking, Interface, Framework, Application> | | ||
| Created | <Date created, in ISO 8601 format (YYYY-MM-DD)> | | ||
| Comments-URI | <Leave this blank; it will be assigned by a SIP Editor> | | ||
| Status | <Leave this blank; it will be assigned by a SIP Editor> | | ||
| Requires | <Optional; SIP number(s), comma separated> | | ||
|
||
``` | ||
REMOVE THIS BLOCK BEFORE SUBMITTING SIP | ||
Please read SIP-1 before using this template. | ||
For new SIPs, this template can be copied and filled in. | ||
Note that some headers will be assigned by the SIP Editor; you should leave these fields blank. | ||
Headers that are not required should be removed from the document. | ||
Before submitting, please delete all comments from the template, including this one. | ||
``` | ||
|
||
## Abstract | ||
|
||
``` | ||
REMOVE THIS BLOCK | ||
This section is mandatory, but is usually expanded as the SIP progresses. | ||
``` | ||
|
||
## Motivation | ||
|
||
``` | ||
REMOVE THIS BLOCK | ||
This section is mandatory. | ||
At the early stages of the SIP, this section is important in order to describe the current problem and how the SIP aims to overcome it. | ||
``` | ||
|
||
## Specification | ||
|
||
``` | ||
REMOVE THIS BLOCK | ||
This section is mandatory. | ||
``` | ||
|
||
## Rationale | ||
|
||
``` | ||
REMOVE THIS BLOCK | ||
This section is mandatory. | ||
It should be used to explain how the SIP's design was arrived at, and what the pros and cons of this approach are. | ||
``` | ||
|
||
## Backwards Compatibility | ||
|
||
``` | ||
REMOVE THIS BLOCK | ||
This section is mandatory, but it may simply state that there are no issues with backwards compatability. | ||
If there are backwards incompatabilities, it should be detailed how these will addressed. | ||
``` | ||
|
||
## Test Cases | ||
|
||
``` | ||
REMOVE THIS BLOCK | ||
This section is optional. | ||
It is usually recommended to not include test cases when first submitting the SIP, and instead focus on the design and problem statement. | ||
``` | ||
|
||
## Reference Implementation | ||
|
||
``` | ||
REMOVE THIS BLOCK | ||
This section is optional. | ||
It is usually recommended to not include a reference implementation when first submitting the SIP, and instead focus on the design and problem statement. | ||
``` | ||
|
||
## Security Considerations | ||
|
||
``` | ||
REMOVE THIS BLOCK | ||
This section is mandatory, but it may simply state "None" if there are no relevant considerations. | ||
``` | ||
|
||
## Copyright | ||
|
||
``` | ||
REMOVE THIS BLOCK | ||
This section is optional but recommended. | ||
``` |