Skip to content

Commit bcd4e8f

Browse files
authored
Merge pull request #279 from MunyayLLC/main
Merge pull request #277 from MunyayLLC/copilot/fix-additional-informa…
2 parents 83b97a8 + 017e0bf commit bcd4e8f

19 files changed

Lines changed: 3775 additions & 2448 deletions

.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.
Lines changed: 21 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,38 @@
11
---
2-
name: Bug Report
2+
name: Bug report
33
about: Create a report to help us improve
4-
title: '[BUG] '
5-
labels: 'bug'
6-
assignees: ''
4+
title: ''
5+
labels: ''
6+
assignees: joe10832, Copilot
7+
78
---
89

9-
## Bug Description
10+
**Describe the bug**
1011
A clear and concise description of what the bug is.
1112

12-
## Steps to Reproduce
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
1315
1. Go to '...'
1416
2. Click on '....'
1517
3. Scroll down to '....'
1618
4. See error
1719

18-
## Expected Behavior
20+
**Expected behavior**
1921
A clear and concise description of what you expected to happen.
2022

21-
## Actual Behavior
22-
A clear and concise description of what actually happened.
23-
24-
## Environment Information
25-
- **Onchain Test Kit Version**: [e.g., 1.2.0]
26-
- **Node.js Version**: [e.g., 18.17.0]
27-
- **Operating System**: [e.g., macOS 13.4, Windows 11, Ubuntu 20.04]
28-
- **Browser**: [e.g., Chrome 115, Firefox 116]
29-
- **Wallet**: [e.g., MetaMask, Coinbase Wallet, Phantom]
30-
31-
## Configuration Used
32-
```typescript
33-
// Paste your configuration code here
34-
const config = configure()
35-
.withMetaMask()
36-
// ... other configuration
37-
.build();
38-
```
39-
40-
## Error Logs
41-
```
42-
Paste any error messages, stack traces, or relevant logs here
43-
```
44-
45-
## Code Sample
46-
```typescript
47-
// Minimal code example that reproduces the issue
48-
import { createOnchainTest, configure } from '@coinbase/onchaintestkit';
49-
50-
const test = createOnchainTest(/* your config */);
51-
52-
test('failing test', async ({ page, metamask }) => {
53-
// Steps that cause the bug
54-
});
55-
```
56-
57-
## Screenshots
23+
**Screenshots**
5824
If applicable, add screenshots to help explain your problem.
5925

60-
## Additional Context
61-
Add any other context about the problem here.
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
6230

63-
## Possible Solution
64-
If you have suggestions on how to fix the bug, please describe them here.
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]
6536

66-
## Checklist
67-
- [ ] I have searched for existing issues that describe this bug
68-
- [ ] I have included all the required environment information
69-
- [ ] I have provided a minimal code example that reproduces the issue
70-
- [ ] I have included relevant error messages and logs
37+
**Additional context**
38+
Add any other context about the problem here.

.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: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
22
name: Documentation Issue
33
about: Report an issue with documentation or request documentation improvements
4-
title: '[DOCS] '
5-
labels: 'documentation'
4+
title: "[DOCS] "
5+
labels: documentation
66
assignees: ''
7+
78
---
89

910
## Documentation Issue Type
@@ -65,4 +66,4 @@ If requesting examples or reporting broken code:
6566
- [ ] I have searched for existing documentation issues
6667
- [ ] I have checked if this is covered in other sections
6768
- [ ] I have provided specific suggestions for improvement
68-
- [ ] I have included relevant code examples (if applicable)
69+
- [ ] I have included relevant code examples (if applicable)
Lines changed: 12 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,20 @@
11
---
2-
name: Feature Request
2+
name: Feature request
33
about: Suggest an idea for this project
4-
title: '[FEATURE] '
5-
labels: 'enhancement'
4+
title: ''
5+
labels: ''
66
assignees: ''
7-
---
8-
9-
## Feature Summary
10-
A clear and concise description of the feature you'd like to see added.
11-
12-
## Problem Statement
13-
Describe the problem this feature would solve. Is your feature request related to a problem? Please describe.
14-
Example: "I'm always frustrated when [...]"
15-
16-
## Proposed Solution
17-
Describe the solution you'd like. A clear and concise description of what you want to happen.
18-
19-
## API Design (if applicable)
20-
If this involves API changes, provide examples of how the new feature would be used:
21-
22-
```typescript
23-
// Example of how the new feature would work
24-
const config = configure()
25-
.withNewFeature({
26-
// configuration options
27-
})
28-
.build();
29-
30-
// or
317

32-
await wallet.handleAction('newAction', {
33-
// action parameters
34-
});
35-
```
36-
37-
## Alternatives Considered
38-
Describe any alternative solutions or features you've considered.
39-
40-
## Use Cases
41-
Describe specific use cases for this feature:
42-
1. **Use Case 1**: Description of scenario
43-
2. **Use Case 2**: Description of another scenario
44-
45-
## Implementation Considerations
46-
47-
### Wallet Compatibility
48-
- [ ] MetaMask support needed
49-
- [ ] Coinbase Wallet support needed
50-
- [ ] Phantom Wallet support needed
51-
- [ ] Cross-wallet compatibility required
52-
53-
### Technical Considerations
54-
- [ ] Breaking change required
55-
- [ ] Backward compatibility can be maintained
56-
- [ ] Documentation updates needed
57-
- [ ] Example code needed
8+
---
589

59-
## Additional Context
60-
Add any other context, screenshots, links, or examples about the feature request here.
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 [...]
6112

62-
## Related Issues
63-
- Related to #(issue number)
64-
- Depends on #(issue number)
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
6515

66-
## Priority
67-
How important is this feature to you?
68-
- [ ] Nice to have
69-
- [ ] Important for my use case
70-
- [ ] Critical for my project
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
7118

72-
## Implementation Willingness
73-
- [ ] I would like to implement this feature myself
74-
- [ ] I can help with implementation
75-
- [ ] I need the maintainers to implement this
76-
- [ ] I can provide testing and feedback
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/agents/my-agent.agent.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
# Fill in the fields below to create a basic custom agent for your repository.
3+
# The Copilot CLI can be used for local testing: https://gh.io/customagents/cli
4+
# To make this agent available, merge this file into the default repository branch.
5+
# For format details, see: https://gh.io/customagents/config
6+
7+
name:
8+
description:
9+
---
10+
11+
# My Agent
12+
13+
Describe what your agent does here...

0 commit comments

Comments
 (0)