Merge branch 'gitcoinco:main' into main

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,68 @@
+name: Bug Report
+description: File a bug report
+labels: ["bug", "triage"]
+projects: ["gitcoinco/grants-stack"]
+assignees:
+  - jesuloluwao
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: input
+    id: url
+    attributes:
+      label: What was the URL where the error occurred? 
+      description:
+      placeholder: https://example.com
+    validations:
+      required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: If applicable, add screenshots to help explain your problem.
+      placeholder: 
+      value: "Page X displayed Z..."
+    validations:
+      required: true
+  - type: textarea
+    id: what-expected
+    attributes:
+      label: What should have happened instead?
+      description: A clear and concise description of what you expected the system to do.
+      placeholder: 
+      value: "Page X should display Y"
+    validations:
+      required: true
+  - type: textarea 
+    id: repro
+    attributes:
+      label: Steps to Reproduce
+      description: Issues that developers can reproduce are quicker to resolve 
+      placeholder: "1. Go to '...'\n2. Click on '....'\n3. Scroll down to '....'\n4. See error"
+    validations:
+      required: true
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: What browser(s) are you seeing the problem on?
+      multiple: true
+      options:
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+  - type: input
+    id: chain
+    attributes:
+      label: What chain(s) did the error occur on? 
+      description:
+      placeholder: i.e. Optimism, PGN, etc. 
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,7 @@
 <!-- 
 Thank you for your pull request! Please review the requirements below 
 and ensure your pull request has fulfilled all requirements outlined in the target package.
+Before submitting a PR for review, please make sure that all the CI checks are passing.
 -->
 
 ## PR checklist
@@ -18,6 +19,7 @@ For every PR, make sure that these statements are true:
 - [ ] Parses out-of-domain data - this includes user input, API respones, on-chain data etc.
 - [ ] Doesn't contain commented out code.
 - [ ] Doesn't contain skipped or empty tests.
+- [ ] If this PR adds/updates any feature, it adds/updates its test script
 
 Subjective - at the discretion of the reviewers
 - Does things as simply as possible, but not simpler.

.github/workflows/common.yml

@@ -0,0 +1,35 @@
+name: Common - Test
+on:
+  push:
+    branches:
+      - main
+      - release
+  pull_request:
+    branches:
+      - "**"
+jobs:
+  lint-test-typecheck:
+    concurrency: ci-common-${{ github.head_ref || github.run_id }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 1
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+          cache: "pnpm"
+
+      - name: Install Dependencies
+        run: |
+          pnpm install
+
+      - name: Test Common
+        run: |
+          pnpm c-test

.github/workflows/grant-explorer.yml

@@ -32,12 +32,12 @@ jobs:
 
       - name: Lint Explorer
         run: |
-          pnpm re-lint    
+          pnpm ge-lint    
 
       - name: Test Explorer
         run: |
-          pnpm re-test
+          pnpm ge-test
 
       - name: Typecheck Explorer
         run: |
-          pnpm re-typecheck
+          pnpm ge-typecheck

.github/workflows/verify-env.yml

@@ -0,0 +1,35 @@
+name: Verify-Env - Test
+on:
+  push:
+    branches:
+      - main
+      - release
+  pull_request:
+    branches:
+      - "**"
+jobs:
+  lint-test-typecheck:
+    concurrency: ci-verify-env-${{ github.head_ref || github.run_id }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 1
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+          cache: "pnpm"
+
+      - name: Install Dependencies
+        run: |
+          pnpm install
+
+      - name: Test Verify-Env
+        run: |
+          pnpm ve-test

.prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "trailingComma": "es5"
+}

CONTRIBUTING.md

@@ -1,27 +1,38 @@
 # Contributing to Round Manager and Grant Explorer
 
-Thank you for your desire to contribute to Gitcoin! Below you will find some ways to help, but please don't feel limited by them, and if you have any other ideas, pop by our [Discord](https://discord.gg/gitcoin)
+Thank you for your desire to contribute to Gitcoin! Below you will find some ways to help, but please don't feel limited
+by them, and if you have any other ideas, pop by our [Discord](https://discord.com/channels/562828676480237578/1149808279871049880)
 
 ## Reporting issues
 
 Before reporting an issue, please make sure to verify the following:
+
 - You're running the latest version, including other components and systems the project might interact with
 - Your dependencies are up-to-date
 
-If the issue still persists, search the issue tracker. If there is an open ticket, please don't comment '+1' or similar - use the '👍' emoji. Only comment if you have additional context, reproduction instructions or anything that might help resolve the issue.
+If the issue still persists, search the issue tracker. If there is an open ticket, please don't comment '+1' or
+similar - use the '👍' emoji. Only comment if you have additional context, reproduction instructions or anything that
+might help resolve the issue.
 
 When opening a new issue, make sure it contains the following:
+
 - Step-by-step reproduction instructions
 - Screenshots or videos of the issue, if applicable
 - Version information of the project
 - Any other context that you feel would help resolve the issue
 
 ## Contributing code
 
-We welcome all code contributions, large or small. Please see [DEV.md](packages/round-manager/docs/DEV.md) for instructions on how to set up the project for development.
+We welcome all code contributions, large or small. Please see [DEV.md](docs/DEV.md) for
+instructions on how to set up the project for development.
 
-Before submitting a PR, please make sure that all tests, linting and formatting rules are passing.
+Before submitting a PR for review, please make sure that all the CI checks are passing.
+We also utilize git hooks for pre-commit
+formatting and pre-push checks, which should help you catch issues early, before they fail the CI.
 
-We squash all PRs by default. You can request your PR commits to not be squashed if they're well named and organized, and it would make sense to preserve their context.
+We squash all PRs by default. When updating your PR branch, use merge if it's in review, or rebase otherwise, at your
+own discretion.
 
-_To keep the repository clean, we may mark PRs as stale if there has been no activity for more than a week, which are then subject to closure and deletion. If you are stuck, feel free to reach out for help in [Discord](https://discord.gg/gitcoin)._ 
+_To keep the repository clean, we may mark PRs as stale if there has been no activity for more than a week, which are
+then subject to closure and deletion. If you are stuck, feel free to reach out for help
+in [Discord](https://discord.com/channels/562828676480237578/1149808279871049880)._ 

README.md

@@ -8,91 +8,31 @@ This repository contains packages needed for a user to
 Project Maintained via  : `turborepo`
 Package manager         : `pnpm`
 
-## Directory Structure
+## Packages
+
+- round-manager: React application for managing rounds
+- grant-explorer: React application for exploring the grants ecosystem
+- builder: React application for managing projects
+- common: components and functionality that is shared between projects
+- eslint-config-gitcoin: common eslint config for all grants stack projects
+- verify-env: a utility package and a webpack plugin for verifying the environment of an app during build
+
 
 ```
 .
 ├── .github                     # github specific configuration
-├── packages
-│   ├── round-manager           # react-frontend for round-manager
-│   ├── grant-explorer          # react-frontend for grant-explorer
-│   ├── builder                 # react-frontend for builder
-│   ├── common                  # components and functionality that is shared between projects
-│   ├── eslint-config-gitcoin   # common eslint config for all grants stack projects
+├── packages                    # individual frontends and related packages
 ├── package.json                # root package configuration
+├── docs                        # documentation
 └── README.md
 ```
 
-## Git Hooks
-You can optionally enable pre-commit git hooks that autoformat your changed code using prettier.
-
-```bash
-brew install lefthook
-lefthook install
-```
-
-inspect the current hook configuration in [lefthook.yml](lefthook.yml)
-
-## contracts
-
-The contracts needed for running a round can be found within the [Allo contracts repository](https://github.com/Allo-Protocol/contracts)
-
-### graph
-
-The subgraph which indexs data with regard the
-- ProgramFactory
-- ProgramImplementation
-- RoundFactory
-- RoundImplementation
-
-More information can be found within the [Allo graph repository](https://github.com/Allo-Protocol/graph)
-
-## Packages
-
-### round-manager
-
-This package serves the app which holds all the features w.r.t to
-
-- creating a program
-- maintaining a program
-- creating a round
-- maintaining a program
-
-More information can be found within the [round-manager package](packages/round-manager)
-
 ##### Development
 
-We welcome external contributions. Please make sure to familiarize yourself with the [Contribution Guide](CONTRIBUTING.md).
-
-To contribute to this project, fork the project and follow the instructions at [DEV.md](packages/round-manager/docs/DEV.md)
-
-### grant-explorer
+We welcome external contributions. Please make sure to familiarize yourself with the [Contribution Guidelines](CONTRIBUTING.md).
 
-This package serves the app which holds all the features w.r.t to
-
-- exploring a round
-- voting for a project
-
-
-More information can be found within the [grant-explorer package](packages/grant-explorer)
-
-##### Development
-
-We welcome external contributions. Please make sure to familiarize yourself with the [Contribution Guide](CONTRIBUTING.md).
-
-To contribute to this project, fork the project and follow the instructions at [DEV.md](packages/grant-explorer/docs/DEV.md)
+To contribute to this project, fork the repo and follow the instructions at [DEV.md](docs/DEV.md)
 
 ##### Hosting
 
-All the frontend dApps are hosted via [fleek.co](https://fleek.co/).
-
-Documented below are the environments along with the URL.
-
-Note: Live Deployment should always happen by raising a PR from `main` to `release`
-
-**round-manager**
-
-| Env     | Git Branch | URL                               |
-|---------|------------|-----------------------------------|
-| STAGING | main       | https://rmgitcoin.on.fleek.co/    |
-| LIVE    | release    | https://manager.gitcoin.co/ |
+All the apps are hosted on Vercel. Preview links get created automatically for PRs. Commits to main get deployed to production automatically.