Skip to content

Commit 66bcdcd

Browse files
joe10832joe10832
committed
Merge remote-tracking branch 'upstream/main' into copilot/fix-f298f4ee-147c-44d2-88b3-6b4b6d1ca2c4
2 parents 7c4a7e4 + ea41c80 commit 66bcdcd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+18875
-0
lines changed

‎.env.example‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Environment variables for Onchain Test Kit
2+
# Copy this file to .env and fill in your values
3+
4+
# Test wallet seed phrase (NEVER use real funds - test wallets only!)
5+
E2E_TEST_SEED_PHRASE="your-test-seed-phrase-here"
6+
7+
# Optional: RPC URLs for fork mode testing
8+
# ETHEREUM_RPC_URL="https://eth-mainnet.g.alchemy.com/v2/your-api-key"
9+
# BASE_RPC_URL="https://mainnet.base.org"
10+
# ARBITRUM_RPC_URL="https://arb1.arbitrum.io/rpc"
11+
12+
# Optional: Test configuration
13+
# TEST_TIMEOUT=30000
14+
# BROWSER_HEADLESS=false

‎.github/FUNDING.yml‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# These are supported funding model platforms
2+
3+
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
12+
polar: # Replace with a single Polar username
13+
buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
14+
thanks_dev: # Replace with a single thanks.dev username
15+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
16+
README.md# OnChainTestKit - Enterprise Web3 Testing Framework
17+
18+
[![CI/CD Pipeline](https://github.com/MunyayLLC/onchaintestkit/actions/workflows/ci-complete.yml/badge.svg)](https://github.com/MunyayLLC/onchaintestkit/actions/workflows/ci-complete.yml)
19+
[![Copilot Setup](https://github.com/MunyayLLC/onchaintestkit/actions/workflows/copilot-setup.yml/badge.svg)](https://github.com/MunyayLLC/onchaintestkit/actions/workflows/copilot-setup.yml)
20+
[![codecov](https://codecov.io/gh/MunyayLLC/onchaintestkit/branch/main/graph/badge.svg)](https://codecov.io/gh/MunyayLLC/onchaintestkit)
21+
[![License](https://img.shields.io/github/license/MunyayLLC/onchaintestkit)](LICENSE)
22+
[![SLSA 3](https://slsa.dev/images/gh-badge-level3.svg)](https://slsa.dev)
23+
24+
Enterprise-grade end-to-end testing toolkit for Web3 applications with built-in Methttps://stackblitz.com/~/github.com/MunyayLLC/https-github.com-joe10832-onchaintestkitnpm install @reown/appkit @reown/appkit-adapter-wagmi wagmi viem @tanstack/react-query# Enterprise-Ready Software Engineering Project
25+
26+
Welcome to the **Enterprise-Ready Software Engineering Project**. This repository is designed for professional development in Python, Java, and C++ with a focus on enterprise-grade solutions, scalability, and maintainability.
27+
28+
---
29+
30+
## 🚀 Business Focus
31+
32+
This project is tailored for **business enterprise-ready** solutions, ensuring professional-grade software engineering practices. It emphasizes:
33+
34+
- **Scalability**: Designed to handle enterprise-level workloads.
35+
- **Maintainability**: Code structured for long-term use and collaboration.
36+
- **Integration**: Seamless integration with existing enterprise systems.
37+
38+
---
39+
40+
## 🧑‍💻 Your Role
41+
42+
- **Role Type**: `{role_type}` expert in `{domain}`
43+
- **Focus Area**: `{key_skill_area}`
44+
45+
As a contributor, your expertise in `{domain}` will help shape the success of this project. Focus on `{key_skill_area}` to ensure high-quality contributions.
46+
47+
---
48+
49+
## 📜 Code Guidelines
50+
51+
### General Guidelines
52+
- Use **language-specific conventions** for Python, Java, and C++.
53+
- Follow **design patterns** and **best practices** for enterprise software.
54+
- Optimize for **performance**, **readability**, and **scalability**.
55+
56+
### Python
57+
- Follow [PEP 8](https://peps.python.org/pep-0008/) for coding standards.
58+
- Use type hints and docstrings for better readability.
59+
- Write unit tests using `unittest` or `pytest`.
60+
61+
### Java
62+
- Adhere to [Oracle's Java Code Conventions](https://www.oracle.com/java/technologies/javase/codeconventions-introduction.html).
63+
- Use Maven or Gradle for dependency management.
64+
- Write JUnit tests for all major components.
65+
66+
### C++
67+
- Follow [Google's C++ Style Guide](https://google.github.io/styleguide/cppguide.html).
68+
- Use `CMake` for build configuration.
69+
- Ensure memory safety and avoid undefined behavior.
70+
71+
---
72+
73+
## 🔧 Integration
74+
75+
This project is designed to integrate seamlessly with enterprise systems. Key integration points include:
76+
77+
- **APIs**: RESTful APIs for communication between services.
78+
- **Databases**: Support for relational and NoSQL databases.
79+
- **CI/CD Pipelines**: Automated testing and deployment workflows.
80+
81+
---
82+
83+
## 📚 Further Reading
84+
85+
- [Python Best Practices](https://realpython.com/)
86+
- [Java Design Patterns](https://java-design-patterns.com/)
87+
- [C++ Modern Practices](https://isocpp.org/)
88+
89+
---
90+
91+
For questions or support, please open an issue or contact the project maintainer.# GitHub Copilot Configuration & Setup
92+
93+
Welcome to AI-powered pair programming with GitHub Copilot! This guide will help you quickly onboard and configure Copilot for use with Python, Java, and C++ projects in this repository.
94+
95+
---
96+
97+
## 1. Enable Copilot for Your GitHub Account
98+
99+
1. Ensure you have a [GitHub Copilot license](https://github.com/features/copilot).
100+
2. Go to **Settings > Copilot** in your GitHub account and enable Copilot for your user or organization.
101+
102+
---
103+
104+
## 2. Install the Copilot Extension
105+
106+
Copilot is available for popular editors:
107+
108+
- **Visual Studio Code**: [Copilot for VS Code](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot)
109+
- **JetBrains IDEs** (IntelliJ, PyCharm, CLion, etc.): [Copilot for JetBrains](https://plugins.jetbrains.com/plugin/17718-github-copilot)
110+
- **Neovim**: [Copilot for Neovim](https://github.com/github/copilot.vim)
111+
112+
Install the extension and sign in with your GitHub account.
113+
114+
---
115+
116+
## 3. Project-Specific Setup
117+
118+
### Python
119+
120+
- Use a virtual environment (`python -m venv venv`).
121+
- Ensure `requirements.txt` or `pyproject.toml` is present for dependency management.
122+
- Copilot works best with clear docstrings and type hints.
123+
124+
### Java
125+
126+
- Ensure your project has a proper `pom.xml` (Maven) or `build.gradle` (Gradle) configuration.
127+
- Use standard directory layouts (`src/main/java`, `src/test/java`).
128+
- Document classes and methods for better Copilot context.
129+
130+
### C++
131+
132+
- Use a `CMakeLists.txt` or relevant build configuration file.
133+
- Organize code in `include/` and `src/` directories.
134+
- Comment header files and provide signature documentation.
135+
136+
---
137+
138+
## 4. Best Practices for Copilot
139+
140+
- Write descriptive comments and docstrings—Copilot uses them for smarter suggestions.
141+
- Break up large files and functions for better context.
142+
- Use meaningful variable and function names.
143+
- Regularly review and refactor Copilot's code for security and correctness.
144+
145+
---
146+
147+
## 5. Troubleshooting
148+
149+
- If Copilot suggestions are not relevant, add more context or comments.
150+
- For editor-specific troubleshooting, refer to the [Copilot Docs](https://docs.github.com/en/copilot/getting-started-with-github-copilot).
151+
152+
---
153+
154+
## 6. Further Reading
155+
156+
- [GitHub Copilot Documentation](https://docs.github.com/en/copilot)
157+
- [Onboarding Guide](../README.md#onboarding)
158+
- [Contribution Guide](../CONTRIBUTING.md)
159+
160+
---
161+
162+
For questions or support, open an issue or contact your team lead.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Discussions
4+
url: https://github.com/MunyayLLC/https-github.com-joe10832-onchaintestkit/discussions
5+
about: Ask questions, share ideas, and discuss with the community
6+
- name: 📚 Documentation
7+
url: https://github.com/MunyayLLC/https-github.com-joe10832-onchaintestkit#readme
8+
about: Read the project documentation and examples

‎.github/ISSUE_TEMPLATE/custom.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Custom issue template
3+
about: Describe this issue template's purpose here.
4+
title: ''
5+
labels: ''
6+
assignees: joe10832
7+
8+
---
9+
10+

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
name: Documentation Issue
3+
about: Report an issue with documentation or request documentation improvements
4+
title: "[DOCS] "
5+
labels: documentation
6+
assignees: ''
7+
8+
---
9+
10+
## Documentation Issue Type
11+
- [ ] Error in existing documentation
12+
- [ ] Missing documentation
13+
- [ ] Unclear or confusing documentation
14+
- [ ] Example code not working
15+
- [ ] Request for additional examples
16+
17+
## Location
18+
Where is the documentation issue located?
19+
- [ ] README.md
20+
- [ ] API documentation (JSDoc comments)
21+
- [ ] Examples in `/example` directory
22+
- [ ] Documentation in `/docs` directory
23+
- [ ] GitHub Copilot instructions (`.github/copilot-instructions.md`)
24+
- [ ] Contributing guide
25+
- [ ] Other: ____________
26+
27+
## Current Documentation
28+
If reporting an error or unclear section, please quote the current documentation:
29+
30+
```
31+
Current text that has issues...
32+
```
33+
34+
## Issue Description
35+
Clearly describe what's wrong or what's missing:
36+
37+
## Suggested Improvement
38+
What would you like to see instead?
39+
40+
```
41+
Suggested text or structure...
42+
```
43+
44+
## Use Case
45+
Describe the scenario or use case that this documentation would help with:
46+
47+
## Additional Context
48+
- What were you trying to accomplish when you encountered this issue?
49+
- What documentation would have helped you?
50+
- Are there any external resources that provide good examples?
51+
52+
## Code Example (if applicable)
53+
If requesting examples or reporting broken code:
54+
55+
```typescript
56+
// Code that should work but doesn't
57+
// or code example you'd like to see documented
58+
```
59+
60+
## Environment (if reporting broken examples)
61+
- **Onchain Test Kit Version**: [e.g., 1.2.0]
62+
- **Node.js Version**: [e.g., 18.17.0]
63+
- **Operating System**: [e.g., macOS 13.4]
64+
65+
## Checklist
66+
- [ ] I have searched for existing documentation issues
67+
- [ ] I have checked if this is covered in other sections
68+
- [ ] I have provided specific suggestions for improvement
69+
- [ ] I have included relevant code examples (if applicable)

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)