diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..68d5622 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,34 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug"] +assignees: [] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: How can we reproduce the bug? + description: If you can make the bug happen again, please share the steps involved. If possible please also include a screenshot or a screen recording to help us better understand and resolve the issue. + validations: + required: false + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..4e2d3ca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,17 @@ +name: Feature request +description: File a feature request +title: "[Feature]: " +labels: ["enhancement"] +assignees: [] +body: + - type: markdown + attributes: + value: | + Have an idea for a feature or change? + - type: textarea + id: description + attributes: + label: What's the feature? + description: Describe the feature, who it would help, and link to any examples from other apps. + validations: + required: true diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml new file mode 100644 index 0000000..14104d5 --- /dev/null +++ b/.github/workflows/continuous-integration.yml @@ -0,0 +1,50 @@ +name: CI +on: + pull_request: + push: + branches: + - main + +jobs: + prettier: + name: Prettier + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + ref: ${{ github.head_ref }} + - uses: actions/setup-node@v1 + with: + node-version: "18.x" + - run: npm ci + - run: npm run fmt + - name: Commit changes + uses: stefanzweifel/git-auto-commit-action@v4.1.2 + with: + commit_message: Apply formatting changes + branch: ${{ github.head_ref }} + playwright-tests: + name: Playwright tests + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: "18.x" + cache: "npm" + - uses: actions/cache@v3 + id: playwright-cache + with: + path: | + ~/.cache/ms-playwright + key: ${{ runner.os }}-playwright-${{ hashFiles('**/package-lock.json') }} + - name: Install dependencies + run: npm ci + - name: Install dependencies + run: | + npx playwright install-deps + npx playwright install + if: steps.playwright-cache.outputs.cache-hit != 'true' + - name: Run tests + run: | + npx playwright test diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7c34ba8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,41 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.js +.yarn/install-state.gz +/.unlighthouse + +# testing +/coverage + +# next.js +/.next/ +/out/ + +# production +/build + +# misc +.DS_Store +*.pem + +# debug +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# local env files +.env*.local + +# vercel +.vercel + +# typescript +*.tsbuildinfo +next-env.d.ts +/test-results/ +/playwright-report/ +/blob-report/ +/playwright/.cache/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7aed4e3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing Guide + +Thank you for considering contributing to this project! Here are some guidelines to help you get started. + +## Getting Started + +To contribute to this project, follow these steps: + +1. Fork the repository on GitHub. +2. Clone your forked repository to your local machine. +3. Make your changes locally. +4. Test your changes to ensure they work as expected. +5. Commit your changes with descriptive commit messages. We like [Semantic Commit Messages](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716). +6. Push your changes to your fork on GitHub. +7. Create a pull request to the main repository. + +## Code Style + +Please follow the existing code style and conventions used in the project. + +## Testing + +This repository uses playwright tests, which can be found in [/playwright-tests](./playwright-tests/). Ensure that your changes include appropriate tests and that existing tests pass. + +## Submitting Issues + +If you encounter any issues or have feature requests, please submit them through GitHub issues. Include as much detail as possible to help us understand and address the problem efficiently. + +Thank you for your interest in contributing to this project! Your contributions are greatly appreciated. diff --git a/README.md b/README.md new file mode 100644 index 0000000..08be5ee --- /dev/null +++ b/README.md @@ -0,0 +1,74 @@ + + + + + +
+ This is a basic project template for new Build DAO projects +
+ +