SIREN Improvement Proposals
SIREN Improvement Proposals (SIPs) describe standards for the SIREN protocol, including core protocol specifications, client APIs, and contract standards.
A browsable version of all current and draft SIPs can be found on the official SIP site.
Your first PR should be a first draft of the final SIP. It must meet the formatting criteria enforced by the build (largely, correct metadata in the header). An editor will manually review the first PR for a new SIP and assign it a number before merging it. Make sure you include a discussions-to
header with the URL to a discussion forum or open GitHub issue where people can discuss the SIP as a whole.
If your SIP requires images, the image files should be included in a subdirectory of the assets
folder for that SIP as follows: assets/sip-N
(where N is to be replaced with the SIP number). When linking to an image in the SIP, use relative links such as ../assets/sip-1/image.png
.
The canonical URL for a SIP that has achieved draft status at any point is at https://sips.sirenmarkets.com/. For example, the canonical URL for SIP-1 is https://sips.sirenmarkets.com/SIPS/sip-1.
Open Terminal.
Check whether you have Ruby 2.1.0 or higher installed:
$ ruby --version
If you don’t have Ruby installed, install Ruby 2.1.0 or higher.
Install Bundler:
$ gem install bundler
$ bundle install
$ bundle exec jekyll serve
http://localhost:4000
.More information on Jekyll and GitHub pages here.