Skip to content

Commit 6e51d00

Browse files
authored
Merge pull request #61 from ProvableHQ/chore/contribution-guidelines-remove-wallet-standard
Chore: Preparation to opensource repository
2 parents b38bd38 + 17c97b8 commit 6e51d00

8 files changed

Lines changed: 596 additions & 20 deletions

File tree

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Description
10+
11+
<!-- A clear and concise description of what the bug is. -->
12+
13+
## Steps to Reproduce
14+
15+
1.
16+
2.
17+
3.
18+
19+
## Expected Behavior
20+
21+
<!-- What you expected to happen. -->
22+
23+
## Actual Behavior
24+
25+
<!-- What actually happened. -->
26+
27+
## Environment
28+
29+
<!-- Please provide the following information: -->
30+
31+
- **Package(s) affected**: <!-- e.g., @provablehq/aleo-wallet-adaptor-core, @provablehq/aleo-hooks -->
32+
- **Package version(s)**: <!-- e.g., 0.3.0-alpha.1 -->
33+
- **Node.js version**: <!-- e.g., 18.17.0 -->
34+
- **pnpm version**: <!-- e.g., 10.2.0 -->
35+
- **Browser/Environment**: <!-- e.g., Chrome 120, Node.js, React 18 -->
36+
- **Wallet(s) tested**: <!-- e.g., Leo Wallet, Puzzle Wallet, Shield Wallet -->
37+
- **Network**: <!-- e.g., Testnet3, Mainnet -->
38+
39+
## Code Example
40+
41+
<!-- If applicable, provide a minimal code example that reproduces the issue. -->
42+
43+
```typescript
44+
// Your code here
45+
```
46+
47+
## Error Messages / Stack Traces
48+
49+
<!-- If applicable, paste any error messages or stack traces here. -->
50+
51+
```
52+
Paste error messages here
53+
```
54+
55+
## Screenshots / Videos
56+
57+
<!-- If applicable, add screenshots or videos to help explain your problem. -->
58+
59+
## Additional Context
60+
61+
<!-- Add any other context about the problem here. -->
62+
63+
## Possible Solution
64+
65+
<!-- If you have ideas on how to fix this, please share them here. -->

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Discussions
4+
url: https://github.com/ProvableHQ/aleo-dev-toolkit/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: 📖 Documentation
7+
url: https://github.com/ProvableHQ/aleo-dev-toolkit#readme
8+
about: Check the README and package documentation
9+
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Problem Statement
10+
11+
<!-- Is your feature request related to a problem? Please describe. -->
12+
<!-- Example: I'm always frustrated when [...] -->
13+
14+
## Proposed Solution
15+
16+
<!-- Describe the solution you'd like. -->
17+
18+
## Use Case
19+
20+
<!-- Describe a specific use case or scenario where this feature would be helpful. -->
21+
22+
## Proposed API / Interface
23+
24+
<!-- If applicable, describe what the new API or interface would look like. -->
25+
26+
```typescript
27+
// Example of how the feature might be used
28+
```
29+
30+
## Alternatives Considered
31+
32+
<!-- Describe any alternative solutions or features you've considered. -->
33+
34+
## Additional Context
35+
36+
<!-- Add any other context, mockups, or examples about the feature request here. -->
37+
38+
## Implementation Notes
39+
40+
<!-- If you have ideas on how this could be implemented, please share them here. -->

.github/pull_request_template.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
## Description
2+
3+
<!-- Provide a clear and concise description of what this PR does and why it's needed. -->
4+
5+
## Type of Change
6+
7+
<!-- Please delete options that are not relevant. -->
8+
9+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
10+
- [ ] ✨ New feature (non-breaking change which adds functionality)
11+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] 📝 Documentation update
13+
- [ ] 🎨 Style/formatting changes (no functional changes)
14+
- [ ] ♻️ Code refactoring (no functional changes)
15+
- [ ] ⚡ Performance improvements
16+
- [ ] ✅ Tests (adding or updating tests)
17+
- [ ] 🔧 Build/config changes
18+
- [ ] 🔒 Security improvements
19+
20+
## Packages Changed
21+
22+
<!-- Check all packages that were modified in this PR. -->
23+
24+
- [ ] `@provablehq/aleo-types`
25+
- [ ] `@provablehq/aleo-hooks`
26+
- [ ] `@provablehq/aleo-wallet-standard`
27+
- [ ] `@provablehq/aleo-wallet-adaptor-core`
28+
- [ ] `@provablehq/aleo-wallet-adaptor-react`
29+
- [ ] `@provablehq/aleo-wallet-adaptor-react-ui`
30+
- [ ] `@provablehq/aleo-wallet-adaptor-leo`
31+
- [ ] `@provablehq/aleo-wallet-adaptor-puzzle`
32+
- [ ] `@provablehq/aleo-wallet-adaptor-shield`
33+
- [ ] `@provablehq/aleo-wallet-adaptor-fox`
34+
- [ ] `@provablehq/aleo-wallet-adaptor-soter`
35+
- [ ] Examples
36+
- [ ] Documentation
37+
- [ ] Root/Config files
38+
39+
## Changeset
40+
41+
<!-- Have you created a changeset for this PR? See CONTRIBUTING.md for details. -->
42+
43+
- [ ] I have created a changeset using `pnpm changeset`
44+
- [ ] This PR does not require a changeset (documentation only, internal refactoring, etc.)
45+
46+
## Testing
47+
48+
<!-- Describe the tests you ran and how you verified your changes work. -->
49+
50+
- [ ] I have tested this locally
51+
- [ ] I have tested with the example applications
52+
- [ ] I have added/updated tests (if applicable)
53+
- [ ] All existing tests pass
54+
55+
### Test Details
56+
57+
<!-- Provide details about your testing approach: -->
58+
59+
## Checklist
60+
61+
<!-- Ensure all of the following are completed before requesting review. -->
62+
63+
- [ ] My code follows the project's style guidelines
64+
- [ ] I have performed a self-review of my own code
65+
- [ ] I have commented my code, particularly in hard-to-understand areas
66+
- [ ] I have updated the documentation accordingly (README, JSDoc, etc.)
67+
- [ ] My changes generate no new warnings or errors
68+
- [ ] I have added tests that prove my fix is effective or that my feature works
69+
- [ ] New and existing unit tests pass locally with my changes
70+
- [ ] Any dependent changes have been merged and published
71+
72+
## Related Issues
73+
74+
<!-- Link to related issues using keywords (e.g., "Fixes #123", "Closes #456"). -->
75+
76+
Fixes #
77+
Related to #
78+
79+
## Screenshots/Videos (if applicable)
80+
81+
<!-- If your changes include UI modifications, please add screenshots or videos. -->
82+
83+
## Additional Notes
84+
85+
<!-- Any additional information that reviewers should know about this PR. -->
86+

CODE_OF_CONDUCT.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
- Using welcoming and inclusive language
14+
- Being respectful of differing viewpoints and experiences
15+
- Gracefully accepting constructive criticism
16+
- Focusing on what is best for the community
17+
- Showing empathy towards other community members
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
- Trolling, insulting or derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as a physical or email address, without their explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement Guidelines
38+
39+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
40+
41+
### 1. Correction
42+
43+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
44+
45+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
46+
47+
### 2. Warning
48+
49+
**Community Impact**: A violation through a single incident or series of actions.
50+
51+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
52+
53+
### 3. Temporary Ban
54+
55+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
56+
57+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
58+
59+
### 4. Permanent Ban
60+
61+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
62+
63+
**Consequence**: A permanent ban from any sort of public interaction within the community.
64+
65+
## Attribution
66+
67+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html)
68+
69+
For answers to common questions about this code of conduct, see [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq)

0 commit comments

Comments
 (0)