Newton Evolution Proposals (NEPs)

Newton Evolution Proposals (NEPs) describe Proposals for the Newton Project including Economic Model, Personnel, Technical, Community Governance and Business.

We welcome anyone with suggestions related to Newton Project to compile a NEP.

This repository tracks the ongoing status of NEPs.

• NEPs Website is built from NEPs and Docs from this repository.

• All NEPs displays all NEPs merged into this repository, source files are located under NEPS directory.

• NEP Process that governs the NEPs repository.

Contributing to NEPs

Newton Evolution Proposals (NEPs) repository exists as a place to share concrete proposals with potential users of the proposal and the Newton community at large.

Visit NEP Guidelines to learn how to contribute to NEPs.

Docs for Guides are located in ./guides directory in this repository.

Local Development

Prerequisites

1. Open Terminal.

2. Check whether you have NodeJS and Yarn installed:

node --version && yarn --version

If you don't have NodeJS or Yarn installed, install them from NodeJS Download and Yarn Installation.

3. Recursively clone this repository as it contains a submodule.

git clone --recursive https://github.com/newtonproject/NEPs.git

If not cloned with --recursive, update submodule to fetch submodule:

git submodule update --init --recursive

4. Install Dependencies:

yarn

Start Website in Dev Mode

yarn dev

Build Website Files

yarn build

Check Markdown Format Before Making A Commit

We use prettier to check and format Markdown documents.

It is recommended to check your format before making a commit.

Format Check

yarn fc

Format Fix: this will help clean the format

yarn ff

License

• The NEPs and Docs in this repostitory are licensed under the CC0 1.0 Universal (CC0 1.0) Public Domain Dedication.

• The underlying program used to build the website is licensed under the Apache License 2.0.

• Individule files may contains seperated License, those files should use their own Licenses.