Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 105 additions & 12 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,109 @@
**What changed? Why?**
## 📝 Description

**Notes to reviewers**
Provide a clear and concise description of what this PR does.

**How has it been tested?**
## 🔗 Related Issues

Have you tested the following pages?
- Fixes #
- Related to #

BaseWeb
- [] base.org
- [] base.org/names
- [] base.org/builders
- [] base.org/ecosystem
- [] base.org/name/jesse
- [] base.org/manage-names
- [] base.org/resources
## 🧪 Type of Change

- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
- [ ] ✨ New feature (non-breaking change which adds functionality)
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] 📚 Documentation update
- [ ] 🎨 Code style/formatting changes
- [ ] ♻️ Code refactoring (no functional changes)
- [ ] ⚡ Performance improvements
- [ ] 🧪 Test coverage improvements
- [ ] 🔧 Build/CI improvements

## 🎯 Changes Made

### Added
-

### Changed
-

### Removed
-

## 🧪 Testing

- [ ] Unit tests pass
- [ ] Integration tests pass
- [ ] E2E tests pass
- [ ] Manual testing completed
- [ ] Cross-browser testing (if applicable)

## 📸 Screenshots/Videos

### Before

### After

## 🔍 Review Checklist

### Code Quality
- [ ] Code follows the project's style guidelines
- [ ] Self-review of the code has been performed
- [ ] Code is properly commented where necessary
- [ ] No console.log statements left in production code
- [ ] No unused imports or variables

### Performance
- [ ] No performance regressions introduced
- [ ] Bundle size impact considered (if applicable)

### Security
- [ ] No security vulnerabilities introduced
- [ ] Input validation implemented (if applicable)

### Accessibility
- [ ] WCAG guidelines followed (if applicable)
- [ ] Keyboard navigation works
- [ ] Screen reader compatibility maintained

## 🚀 Deployment Notes

- [ ] Environment variables updated (if needed)
- [ ] Database migrations required (if applicable)
- [ ] Feature flags configured (if applicable)

## 📋 Additional Notes

## 🔄 Breaking Changes

## 📊 Performance Impact

## 🌐 Browser/Device Testing

- [ ] Chrome (latest)
- [ ] Firefox (latest)
- [ ] Safari (latest)
- [ ] Edge (latest)
- [ ] Mobile Safari
- [ ] Chrome Mobile

## 🎨 Design Review

- [ ] Design review completed
- [ ] Design system compliance verified
- [ ] Responsive design tested

## 📝 Documentation Updates

- [ ] README.md
- [ ] API documentation
- [ ] Component documentation
- [ ] Deployment guides

---

**Reviewer Guidelines:**
- Please test the changes locally if possible
- Check for any potential security issues
- Verify that the implementation matches the requirements
- Ensure code quality and maintainability standards are met
134 changes: 134 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
# Changelog

All notable changes to the Base Web project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added
- 🚀 Comprehensive Quickstart section with step-by-step setup instructions
- 🏗️ Detailed Architecture documentation with tech stack overview
- 🔧 Complete Development Workflow guide with prerequisites and commands
- 🧪 Extensive Testing documentation covering unit tests and E2E testing
- 🚀 Production Deployment guide with environment variables and Docker setup
- 🔍 Troubleshooting section with common issues and solutions
- 📁 Visual Project Structure documentation
- 📋 Streamlined Pull Request template with comprehensive checklists
- 📚 Enhanced CONTRIBUTING.md with development guidelines and standards
- 🐳 Complete Docker documentation with development and production setups
- ⚙️ Improved E2E testing documentation with detailed configuration
- 📝 Environment variables template (env.example) with categorized examples

### Enhanced
- 📖 README.md structure and content for better developer experience
- 🔧 CONTRIBUTING.md with detailed coding conventions and Git workflow
- 🧪 E2E testing documentation with comprehensive setup instructions
- 📋 PR template streamlined for better review process

### Documentation
- Added TypeScript/JavaScript coding standards
- Added React/Next.js best practices
- Added Git workflow with branch naming and commit conventions
- Added comprehensive testing guidelines
- Added code review process documentation
- Added common development tasks instructions
- Added Docker containerization guide
- Added environment configuration examples

---

## [Previous Releases]

### [1.0.0] - 2024-01-XX

#### Added
- Initial Base Web project setup
- Next.js 15 with App Router configuration
- TypeScript setup with strict configuration
- Tailwind CSS with custom design system
- Wagmi v2 + Viem for blockchain interactions
- Three.js with React Three Fiber for 3D graphics
- Framer Motion for animations
- Jest + Playwright for testing
- ESLint and Prettier configuration
- GitHub Actions CI/CD pipeline
- Docker containerization
- Comprehensive component library
- Ecosystem page with project listings
- Basename registration system
- Wallet integration (MetaMask, Coinbase Wallet)
- Analytics integration (Datadog, Bugsnag)
- Performance monitoring with Million.js

#### Technical Stack
- **Framework**: Next.js 15 with App Router
- **Language**: TypeScript 5.0+
- **Styling**: Tailwind CSS with custom design system
- **Blockchain**: Wagmi v2 + Viem for Ethereum interactions
- **3D Graphics**: Three.js with React Three Fiber
- **Animation**: Framer Motion
- **Testing**: Jest + Playwright for E2E
- **Deployment**: Vercel with custom Docker configuration
- **Database**: PostgreSQL with Kysely
- **Caching**: Redis
- **Image Management**: Cloudinary
- **Analytics**: Datadog, Bugsnag
- **Monitoring**: Custom performance tracking

---

## How to Update This Changelog

When making changes to the project:

1. **Add new entries** under the `[Unreleased]` section
2. **Use appropriate categories**:
- `Added` for new features
- `Changed` for changes in existing functionality
- `Deprecated` for soon-to-be removed features
- `Removed` for removed features
- `Fixed` for bug fixes
- `Security` for vulnerability fixes
3. **Use emojis** for better readability
4. **Link to issues/PRs** when relevant
5. **Update version** when releasing

### Example Entry
```markdown
### Added
- 🎉 New user dashboard with analytics
- 🔐 Enhanced authentication with 2FA
- 📱 Mobile-responsive design improvements

### Fixed
- 🐛 Resolved wallet connection timeout issues
- 🔧 Fixed build process for Windows users

### Changed
- ♻️ Refactored authentication flow for better UX
- 📈 Improved performance metrics collection
```

---

## Versioning

This project uses [Semantic Versioning](https://semver.org/):

- **MAJOR** version when you make incompatible API changes
- **MINOR** version when you add functionality in a backwards compatible manner
- **PATCH** version when you make backwards compatible bug fixes

## Release Process

1. Update version in `package.json`
2. Update this `CHANGELOG.md`
3. Create a release tag
4. Update documentation if needed
5. Deploy to production

---

For questions about this changelog or the release process, please reach out in #developer-chat in the [Base Discord](https://base.org/discord).
Loading