mirror of
https://github.com/pezkuwichain/docs.git
synced 2026-04-22 05:27:55 +00:00
docs: add Pezkuwi-SDK documentation
- Technical documentation - SDK guides - Architecture overview - Whitepaper - Contributor guides
This commit is contained in:
@@ -0,0 +1,74 @@
|
||||
## Description
|
||||
|
||||
<!-- A concise description of what your PR does and what issue it solves -->
|
||||
<!-- Use GitHub semantic linking: Fixes #123, Closes #456 -->
|
||||
|
||||
## Type of Change
|
||||
|
||||
- [ ] Bug fix (non-breaking change that fixes an issue)
|
||||
- [ ] New feature (non-breaking change that adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
|
||||
- [ ] Pallet change (changes to custom pallets in `/pezkuwi/pallets/`)
|
||||
- [ ] Runtime change (changes to runtime configuration)
|
||||
- [ ] XCM/Cross-chain change
|
||||
- [ ] Documentation update
|
||||
- [ ] CI/CD change
|
||||
|
||||
## Changes Made
|
||||
|
||||
<!-- List the specific changes made in this PR -->
|
||||
|
||||
-
|
||||
|
||||
## Testing
|
||||
|
||||
<!-- Describe the tests you ran and how to reproduce them -->
|
||||
|
||||
- [ ] Unit tests pass (`cargo test`)
|
||||
- [ ] Build succeeds (`cargo build --release`)
|
||||
- [ ] Benchmarks compile (`cargo build --release --features runtime-benchmarks`)
|
||||
- [ ] Manual testing completed (describe below)
|
||||
|
||||
### Test Details
|
||||
|
||||
<!-- How did you test this change? -->
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] My code follows the project's style guidelines
|
||||
- [ ] I have performed a self-review of my code
|
||||
- [ ] I have commented my code, particularly in hard-to-understand areas
|
||||
- [ ] I have made corresponding changes to the documentation
|
||||
- [ ] My changes generate no new warnings
|
||||
- [ ] I have added tests that prove my fix is effective or that my feature works
|
||||
- [ ] New and existing unit tests pass locally with my changes
|
||||
- [ ] Any dependent changes have been merged and published
|
||||
|
||||
## Security Considerations
|
||||
|
||||
<!-- For changes to pallets, runtime, or financial logic -->
|
||||
|
||||
- [ ] No new security vulnerabilities introduced
|
||||
- [ ] Financial calculations reviewed for overflow/underflow
|
||||
- [ ] Access control properly implemented
|
||||
- [ ] No sensitive data exposed
|
||||
|
||||
## Breaking Changes
|
||||
|
||||
<!-- If this is a breaking change, describe the impact and migration path -->
|
||||
|
||||
N/A
|
||||
|
||||
## Related Issues/PRs
|
||||
|
||||
<!-- Link any related issues or PRs -->
|
||||
|
||||
-
|
||||
|
||||
---
|
||||
|
||||
**For Reviewers:**
|
||||
- Check that tests cover the changes adequately
|
||||
- Verify no regressions in existing functionality
|
||||
- For pallet changes: review weight calculations
|
||||
- For XCM changes: verify cross-chain compatibility
|
||||
Reference in New Issue
Block a user