Skip to content

Commit 8fc4df7

Browse files
akshatcoder-hashakshatcoder-hash
committed
chore: add project templates and remove unused oracle errors
1 parent c269183 commit 8fc4df7

File tree

12 files changed

+402
-12
lines changed

12 files changed

+402
-12
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: Create a report to help us improve
4+
labels: bug
5+
---
6+
7+
## Describe the Bug
8+
A clear and concise description of what the bug is.
9+
10+
## To Reproduce
11+
Steps to reproduce the behavior:
12+
1. Go to '...'
13+
2. Run command '....'
14+
3. See error
15+
16+
## Expected Behavior
17+
A clear and concise description of what you expected to happen.
18+
19+
## Screenshots/Logs
20+
If applicable, add screenshots or logs to help explain your problem.
21+
22+
## Environment
23+
- OS: [e.g., macOS, Windows, Linux]
24+
- Version [e.g., 1.0.0]
25+
- Rust Version: [e.g., 1.65.0]
26+
27+
## Additional Context
28+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

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

‎.github/pull_request_template.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## Description
2+
3+
<!-- Please include a summary of the changes and the related issue. Please also include relevant motivation and context. -->
4+
5+
Fixes # (issue)
6+
7+
## Type of Change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] Documentation update
15+
- [ ] Refactor (changes to code, but no functional changes)
16+
- [ ] Test updates
17+
- [ ] Build/CI updates
18+
19+
## How Has This Been Tested?
20+
21+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
22+
23+
- [ ] Test A
24+
- [ ] Test B
25+
26+
**Test Configuration**:
27+
* OS:
28+
* Rust version:
29+
* Dependencies:
30+
31+
## Checklist:
32+
33+
- [ ] My code follows the style guidelines of this project
34+
- [ ] I have performed a self-review of my own code
35+
- [ ] I have commented my code, particularly in hard-to-understand areas
36+
- [ ] I have made corresponding changes to the documentation
37+
- [ ] My changes generate no new warnings
38+
- [ ] I have added tests that prove my fix is effective or that my feature works
39+
- [ ] New and existing unit tests pass locally with my changes
40+
- [ ] Any dependent changes have been merged and published in downstream modules
41+
42+
## Additional Notes
43+
44+
<!-- Add any additional information that would be helpful for reviewers. -->

‎.gitignore

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,12 @@
1-
/target
1+
### Rust ###
2+
# Generated by Cargo
3+
# will have compiled files and executables
4+
debug/
5+
target/
6+
# These are backup files generated by rustfmt
7+
**/*.rs.bk
8+
9+
# MSVC Windows builds of rustc generate these, which store debugging information
10+
*.pdb
11+
212
.claude

‎CHANGELOG.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
### Added
10+
- Oracle detection and migration guide with APRO integration
11+
- Configuration for handling cluster and programs changes
12+
- Basic project structure and core functionality
13+
14+
## [0.2.0] - 2025-06-02
15+
### Added
16+
- Oracle detection functionality
17+
- APRO integration guide generation
18+
- Enhanced configuration handling
19+
- Comprehensive test suite
20+
- Documentation improvements
21+
22+
## [0.1.3] - 2024-11-14
23+
### Changed
24+
- Updated configuration handling for better cluster and program management
25+
- Improved error handling and user feedback
26+
27+
## [0.1.2] - 2024-11-08
28+
### Changed
29+
- Updated RPC URL in README to include '/rpc' path
30+
- Improved test coverage
31+
32+
## [0.1.1] - 2024-11-08
33+
### Fixed
34+
- Fixed Anchor.toml URL path in the code
35+
- Removed unused dependencies and modules
36+
37+
## [0.1.0] - 2024-11-08
38+
### Added
39+
- Initial release of soon-migrate
40+
- Core functionality for migrating Solana Anchor projects to SOON Network
41+
- Support for basic configuration updates and backups
42+
- Command-line interface with various options
43+
44+
[Unreleased]: https://github.com/akshatcoder-hash/soon-migrate/compare/v0.2.0...HEAD
45+
[0.2.0]: https://github.com/akshatcoder-hash/soon-migrate/compare/v0.1.3...v0.2.0
46+
[0.1.3]: https://github.com/akshatcoder-hash/soon-migrate/compare/v0.1.2...v0.1.3
47+
[0.1.2]: https://github.com/akshatcoder-hash/soon-migrate/compare/v0.1.1...v0.1.2
48+
[0.1.1]: https://github.com/akshatcoder-hash/soon-migrate/compare/v0.1.0...v0.1.1
49+
[0.1.0]: https://github.com/akshatcoder-hash/soon-migrate/releases/tag/v0.1.0

‎CODE_OF_CONDUCT.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers 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.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or 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. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
44+
45+
[homepage]: https://www.contributor-covenant.org

‎CONTRIBUTING.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Contributing to soon-migrate
2+
3+
Thank you for your interest in contributing to soon-migrate! We appreciate your time and effort in helping improve this tool.
4+
5+
## Code of Conduct
6+
7+
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it before making any contributions.
8+
9+
## Getting Started
10+
11+
### Prerequisites
12+
13+
- Rust (latest stable version)
14+
- Cargo (Rust's package manager)
15+
- Git
16+
17+
### Setting Up the Development Environment
18+
19+
1. Fork the repository on GitHub
20+
2. Clone your fork locally:
21+
```bash
22+
git clone https://github.com/your-username/soon-migrate.git
23+
cd soon-migrate
24+
```
25+
3. Build the project:
26+
```bash
27+
cargo build
28+
```
29+
4. Run tests:
30+
```bash
31+
cargo test
32+
```
33+
34+
## How to Contribute
35+
36+
### Reporting Bugs
37+
38+
1. Check if the issue has already been reported in the [GitHub Issues](https://github.com/akshatcoder-hash/soon-migrate/issues)
39+
2. If not, create a new issue with a clear title and description
40+
3. Include steps to reproduce the issue and any relevant logs
41+
42+
### Feature Requests
43+
44+
1. Check if the feature has already been requested
45+
2. Open an issue with a clear description of the feature and its benefits
46+
3. Include any relevant use cases or examples
47+
48+
### Pull Requests
49+
50+
1. Fork the repository and create a new branch for your feature/fix:
51+
```bash
52+
git checkout -b feature/your-feature-name
53+
```
54+
2. Make your changes following the code style guidelines
55+
3. Add tests for your changes
56+
4. Update the documentation if necessary
57+
5. Run the test suite and ensure all tests pass:
58+
```bash
59+
cargo test
60+
```
61+
6. Commit your changes with a descriptive commit message
62+
7. Push your branch and open a pull request
63+
64+
## Code Style
65+
66+
- Follow the [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/)
67+
- Run `cargo fmt` before committing
68+
- Run `cargo clippy` to catch common mistakes and improve your code
69+
- Keep lines under 100 characters when possible
70+
71+
## Testing
72+
73+
- Write unit tests for new functionality
74+
- Ensure all tests pass before submitting a PR
75+
- Add integration tests for new features when appropriate
76+
77+
## Documentation
78+
79+
- Update the README.md for significant changes
80+
- Add documentation comments for all public items
81+
- Keep the CHANGELOG.md up to date
82+
83+
## Review Process
84+
85+
1. A maintainer will review your PR as soon as possible
86+
2. Be prepared to address any feedback or requested changes
87+
3. Once approved, a maintainer will merge your PR
88+
89+
## Areas Needing Help
90+
91+
If you're looking to contribute but not sure where to start, here are some areas that could use attention:
92+
93+
1. **Testing**: More test coverage, especially for edge cases
94+
2. **Documentation**: Improving API documentation and examples
95+
3. **Error Handling**: Enhancing error messages and recovery
96+
4. **CI/CD**: Setting up GitHub Actions for automated testing and releases
97+
5. **Performance**: Optimizing the code for better performance
98+
6. **New Features**: Check the issues labeled "help wanted" or "good first issue"
99+
100+
## License
101+
102+
By contributing to this project, you agree that your contributions will be licensed under its [MIT License](LICENSE).
103+
104+
Thank you for contributing to soon-migrate! 🚀

‎Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "soon-migrate"
3-
version = "0.1.3"
3+
version = "0.2.0"
44
edition = "2021"
55
authors = ["Akshat Sharma <[email protected]>"]
66
description = "CLI tool to migrate Solana Anchor projects to the SOON Network."

‎clippy.toml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Documentation
2+
# https://rust-lang.github.io/rust-clippy/master/
3+
4+
# Allow lints that are triggered by procedural macros
5+
disallowed-methods = [
6+
"std::env::var",
7+
"std::env::set_var",
8+
"std::fs::File::create",
9+
"std::fs::File::open",
10+
"std::fs::read",
11+
"std::fs::read_dir",
12+
"std::fs::read_link",
13+
"std::fs::read_to_string",
14+
"std::fs::write",
15+
"std::process::Command::new",
16+
]
17+
18+
# Allow some lints that are too strict or not applicable
19+
disallowed-types = [
20+
"std::boxed::Box",
21+
"std::vec::Vec",
22+
]
23+
24+
# Allow some lints that are too strict or not applicable
25+
# in test code
26+
test-init-order = false
27+
28+
# Allow some lints that are too strict or not applicable
29+
# in test code
30+
test-unstable-lint = false
31+
32+
# Allow some lints that are too strict or not applicable
33+
# in test code
34+
too-many-arguments = { threshold = 10 }
35+
36+
# Allow some lints that are too strict or not applicable
37+
# in test code
38+
too-many-lines = { threshold = 1000 }
39+
40+
# Allow some lints that are too strict or not applicable
41+
# in test code
42+
type-complexity = { threshold = 25 }
43+
44+
# Allow some lints that are too strict or not applicable
45+
# in test code
46+
module-name-repetitions = { threshold = 20 }
47+
48+
# Allow some lints that are too strict or not applicable
49+
# in test code
50+
result-unit-err = false
51+
52+
# Allow some lints that are too strict or not applicable
53+
# in test code
54+
wildcard-imports = false
55+
56+
# Allow some lints that are too strict or not applicable
57+
# in test code
58+
missing-errors-doc = false
59+
60+
# Allow some lints that are too strict or not applicable
61+
# in test code
62+
missing-panics-doc = false
63+
64+
# Allow some lints that are too strict or not applicable
65+
# in test code
66+
missing-safety-doc = false
67+
68+
# Allow some lints that are too strict or not applicable
69+
# in test code
70+
must-use-candidate = false

0 commit comments

Comments
 (0)