https://github.com/newtonproject/neps
Newton Evolution Proposal
https://github.com/newtonproject/neps
Last synced: 3 months ago
JSON representation
Newton Evolution Proposal
- Host: GitHub
- URL: https://github.com/newtonproject/neps
- Owner: newtonproject
- License: cc0-1.0
- Created: 2020-04-19T09:52:59.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-31T15:10:26.000Z (5 months ago)
- Last Synced: 2025-01-31T16:26:21.693Z (5 months ago)
- Language: HTML
- Homepage: https://neps.newtonproject.org
- Size: 7.36 MB
- Stars: 10
- Watchers: 13
- Forks: 20
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Newton Evolution Proposals (NEPs)
[](https://gitter.im/newtonproject/NEPs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) 
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](https://neps.newtonproject.org/) is built from NEPs and Docs from this repository.
- [All NEPs](https://neps.newtonproject.org/neps/) displays all NEPs merged into this repository, source files are located under `NEPS` directory.
- [NEP Process](https://neps.newtonproject.org/guides/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](https://neps.newtonproject.org/guides/) 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:
```bash
node --version && yarn --version
```
If you don't have NodeJS or Yarn installed, install them from [NodeJS Download](https://nodejs.org/en/download/) and [Yarn Installation](https://yarnpkg.com/getting-started/install).
3. Recursively clone this repository as it contains a submodule.
```bash
git clone --recursive https://github.com/newtonproject/NEPs.git
```
If not cloned with `--recursive`, update submodule to fetch submodule:
```bash
git submodule update --init --recursive
```
4. Install Dependencies:
```bash
yarn
```
### Start Website in Dev Mode
```bash
yarn dev
```
### Build Website Files
```bash
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**
```bash
yarn fc
```
**Format Fix:** this will help clean the format
```bash
yarn ff
```
## License
- The NEPs and Docs in this repostitory are licensed under the [CC0 1.0 Universal (CC0 1.0)
Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/).
- The underlying program used to build the website is licensed under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
- Individule files may contains seperated License, those files should use their own Licenses.