Skip to content

Commit

Permalink
feat: add-license (#39)
Browse files Browse the repository at this point in the history
  • Loading branch information
ramidecodes authored Sep 6, 2023
1 parent b5dbebb commit 689f261
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
22 changes: 17 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Welcome to Scaffold-ETH 2 Contributing Guide
# Welcome to Scaffold-ETH 2 Noir Contributing Guide

Thank you for investing your time in contributing to Scaffold-ETH 2!
Thank you for investing your time in contributing to Scaffold-ETH 2 Noir!

This guide aims to provide an overview of the contribution workflow to help us make the contribution process effective for everyone involved.

## About the Project

Scaffold-ETH 2 is a minimal and forkable repo providing builders with a starter kit to build decentralized applications on Ethereum.
Scaffold-ETH 2 Noir is a minimal and forkable repo providing builders with a starter kit to build decentralized applications on Ethereum.

Read the [README](README.md) to get an overview of the project.

### Vision

The goal of Scaffold-ETH 2 is to provide the primary building blocks for a decentralized application.
The goal of Scaffold-ETH 2 Noir is to provide the primary building blocks for a decentralized application.

The repo can be forked to include integrations and more features, but we want to keep the master branch simple and minimal.

Expand Down Expand Up @@ -44,7 +44,7 @@ Issues should be used to report problems, request a new feature, or discuss pote

#### Solve an issue

Scan through our [existing issues](https://github.com/scaffold-eth/scaffold-eth-2/issues) to find one that interests you.
Scan through our [existing issues](https://github.com/Kryha/scaffold-eth-2-noir/issues) to find one that interests you.

If a contributor is working on the issue, they will be assigned to the individual. If you find an issue to work on, you are welcome to assign it to yourself and open a PR with a fix for it.

Expand All @@ -58,6 +58,18 @@ Some tips to follow when you are creating an issue:
- Include the steps to reproduce the issue or the reason for adding the feature.
- Screenshots, videos etc., are highly appreciated.

### Branch Naming

Accepted branch prefixes:

- `feature/` - for new features
- `fix/` - for bug fixes
- `hotfix/` - for quick fixes to the production branch
- `docs/` - for documentation changes
- `test/` - for adding tests
- `chore/` - for updating build tasks, package manager configs, etc
- `refactor/` - for refactoring code

### Pull Requests

#### Pull Request Process
Expand Down
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "se-2",
"version": "0.0.1",
"name": "se-2-noir",
"version": "0.1.0",
"private": true,
"workspaces": {
"packages": [
Expand Down Expand Up @@ -43,5 +43,6 @@
},
"resolutions": {
"usehooks-ts@^2.7.2": "patch:usehooks-ts@npm:^2.7.2#./.yarn/patches/usehooks-ts-npm-2.7.2-fceffe0e43.patch"
}
},
"license": "MIT"
}

0 comments on commit 689f261

Please sign in to comment.