-
Notifications
You must be signed in to change notification settings - Fork 0
Hardening review: Version 1.1.0, docs polish, and code consistency #7
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| """Analysis package for Neuro-Coherence Framework.""" | ||
|
|
||
| __version__ = "0.1.0" | ||
| __version__ = "1.1.0" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| """fMRI network metrics.""" | ||
|
|
||
| from typing import Optional | ||
| import numpy as np | ||
|
|
||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| # CI Workflow Setup - Complete! 🎉 | ||
| # CI Workflow Setup - Complete | ||
|
|
||
| ## What Was Done | ||
|
|
||
| I've successfully created a comprehensive CI (Continuous Integration) workflow for the Neuro-Coherence Framework repository. Here's what was implemented: | ||
| A comprehensive CI (Continuous Integration) workflow has been created for the Neuro-Coherence Framework repository. Here's what was implemented: | ||
|
||
|
|
||
| ### 1. **GitHub Actions Workflow** (`.github/workflows/ci.yml`) | ||
| - **Lint Job**: Checks code quality with flake8 and formatting with black | ||
|
|
@@ -35,50 +35,41 @@ All local checks pass: | |
| - ✅ **CodeQL security**: Clean scan | ||
| - ✅ **Code review**: No issues found | ||
|
|
||
| ## What You Need to Do 👉 | ||
| ## Approval Process | ||
|
|
||
| The CI workflow is ready to go, but it requires **one-time approval** for security reasons: | ||
| The CI workflow is ready but may require one-time approval for security reasons: | ||
|
|
||
| ### Steps to Approve the Workflow: | ||
|
|
||
| 1. Go to your repository on GitHub: https://github.com/dfeen87/Neuro-Coherence-Framework | ||
|
|
||
| 2. Click on the "Actions" tab | ||
|
|
||
| 3. You should see pending workflow runs with a yellow "⚠️ action_required" status | ||
|
|
||
| 4. Click on any of the pending runs | ||
|
|
||
| 5. You'll see a button that says **"Approve and run"** - click it | ||
|
|
||
| 6. Once approved, the workflow will run automatically on all future commits! | ||
| 1. Navigate to the repository on GitHub. | ||
| 2. Select the "Actions" tab. | ||
| 3. Locate any pending workflow runs with an "action_required" status. | ||
| 4. Select a pending run. | ||
| 5. Click **"Approve and run"**. | ||
| 6. The workflow will subsequently run automatically on future commits. | ||
|
|
||
| ### Expected Result After Approval: | ||
|
|
||
| Once you approve, you'll see the CI workflow run with: | ||
| - ✅ **Lint and Format Check** job passing | ||
| - ✅ **Test** jobs passing (5 jobs, one for each Python version) | ||
| - ✅ **Type Check** job passing (may show warnings, but won't fail) | ||
| The CI workflow will run with: | ||
| - **Lint and Format Check** job passing | ||
| - **Test** jobs passing (5 jobs, one for each Python version) | ||
| - **Type Check** job passing (warnings may appear, but will not fail the job) | ||
|
|
||
| The CI badge in your README will turn **green** ✅ showing "passing" status. | ||
| The CI badge in the README will display a "passing" status. | ||
|
|
||
| ## Future Benefits | ||
| ## CI Benefits | ||
|
|
||
| From now on, every push and pull request will automatically: | ||
| Every push and pull request will automatically: | ||
| 1. Check code quality and formatting | ||
| 2. Run all tests across multiple Python versions | ||
| 3. Verify type hints | ||
| 4. Ensure no security issues are introduced | ||
|
|
||
| This ensures code quality and prevents bugs from reaching the main branch! | ||
|
|
||
| ## Need Help? | ||
|
|
||
| If you encounter any issues or have questions: | ||
| - Check the `docs/CI.md` file for detailed documentation | ||
| - Review workflow run logs in the GitHub Actions tab | ||
| - All checks can be run locally using the commands in `docs/CI.md` | ||
| This maintains code quality and prevents bugs from reaching the main branch. | ||
|
|
||
| --- | ||
| ## Documentation | ||
|
|
||
| **Thank you for the opportunity to contribute to this project!** 🚀 | ||
| For additional information: | ||
| - Consult the `docs/CI.md` file for detailed documentation. | ||
| - Review workflow run logs in the GitHub Actions tab. | ||
| - Execute checks locally using the commands outlined in `docs/CI.md`. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,7 +11,7 @@ | |
| OperatorResult, | ||
| ) | ||
|
|
||
| __version__ = "0.1.0" | ||
| __version__ = "1.1.0" | ||
|
|
||
| __all__ = [ | ||
| "NeuroCoherence", | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
PR description indicates
CONTRIBUTING.mdwas rewritten to remove informal language (personal pronouns/emojis), but the file still contains conversational wording and emoji bullets later (e.g., "We're taking time..." at line 7 and the ✅/❌ list at lines 18–23). Either continue the tone-hardening pass for the remainder of the document or adjust the PR description to match what was actually changed.