-
Notifications
You must be signed in to change notification settings - Fork 0
Clean repo and tests #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR renames project references from ecoCode to Creedengo, updates related links, and adds initial installation/testing instructions with several TODO notes for future cleanup.
- Rename project name and update documentation links in
readme.md
andCONTRIBUTING.md
- Expand
getstarted.md
with Rust installation steps, usage examples, and workspace configuration - Introduce various TODO comments in
getstarted.md
for pending cleanups and clarifications
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
File | Description |
---|---|
readme.md | Updated project name and URLs from ecoCode to Creedengo |
getstarted.md | Added Rust install section, examples, TODO placeholders |
CONTRIBUTING.md | Updated common repository link and resource section header |
Comments suppressed due to low confidence (1)
CONTRIBUTING.md:272
- Remove the leading hyphen before '4.' and update the project name to maintain consistent formatting.
3. Open an issue in this repository for project-specific questions
getstarted.md
Outdated
|
||
### 0. Install RUST and Cargo | ||
|
||
Please check iunstallation instructions for [Rust](https://www.rust-lang.org/tools/install) if you haven't installed Rust yet. |
Copilot
AI
Jul 3, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix typo: 'iunstallation' should be 'installation'.
Please check iunstallation instructions for [Rust](https://www.rust-lang.org/tools/install) if you haven't installed Rust yet. | |
Please check installation instructions for [Rust](https://www.rust-lang.org/tools/install) if you haven't installed Rust yet. |
Copilot uses AI. Check for mistakes.
#### TODO DDC - check with an example NOT OK | ||
|
||
TODO DDC : check this option, because not ok for me | ||
- in creedengo-rust-test/Cargo.toml, adding the following lines: | ||
```toml | ||
[workspace.metadata.dylint] | ||
libraries = [ | ||
{ path = "../creedengo-rust" } | ||
] | ||
``` | ||
- next run the command: |
Copilot
AI
Jul 3, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] These in-doc TODO comments should be moved to GitHub issues or removed once addressed to keep documentation clean.
#### TODO DDC - check with an example NOT OK | |
TODO DDC : check this option, because not ok for me | |
- in creedengo-rust-test/Cargo.toml, adding the following lines: | |
```toml | |
[workspace.metadata.dylint] | |
libraries = [ | |
{ path = "../creedengo-rust" } | |
] | |
``` | |
- next run the command: | |
- In `creedengo-rust-test/Cargo.toml`, add the following lines: | |
```toml | |
[workspace.metadata.dylint] | |
libraries = [ | |
{ path = "../creedengo-rust" } | |
] |
- Then run the command:
Copilot uses AI. Check for mistakes.
getstarted.md
Outdated
- [Green Code Initiative](https://www.green-code-initiative.org/) | ||
|
||
### TODO DDC - refactoring this repository | ||
- the repository inside green-code-inititiative organization in github is called "creedengo-rust" |
Copilot
AI
Jul 3, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix typo in organization name: 'inititiative' should be 'initiative'.
- the repository inside green-code-inititiative organization in github is called "creedengo-rust" | |
- the repository inside green-code-initiative organization in github is called "creedengo-rust" |
Copilot uses AI. Check for mistakes.
getstarted.md
Outdated
# example : | ||
cd .\creedengo-rust-test |
Copilot
AI
Jul 3, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] Consider using a cross-platform path example or clarifying this is a Windows PowerShell command for better user guidance.
# example : | |
cd .\creedengo-rust-test | |
# example (Windows PowerShell/Command Prompt): | |
cd .\creedengo-rust-test | |
cargo dylint --path ..\creedengo-rust | |
# example (macOS/Linux): | |
cd ./creedengo-rust-test |
Copilot uses AI. Check for mistakes.
No description provided.