chore: project renaming + github configuration - #3
Merged
Conversation
- Renamed project to "riskcontrol-todo" and updated description to reflect its purpose. - Added keywords, license information, authors, and maintainers for better project visibility. - Included classifiers and project URLs for enhanced metadata and accessibility.
- Renamed the project from "risk_control" to "mlrisko" across various files including `.gitignore`, `Makefile`, `pyproject.toml`, and `README.md`. - Updated CI configuration to reflect the new project name. - Adjusted import statements in example scripts and modules to align with the new naming convention. - Enhanced project metadata in `pyproject.toml` and updated the README to describe the toolkit's purpose more clearly.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3 +/- ##
=======================================
Coverage 30.27% 30.27%
=======================================
Files 14 14
Lines 621 621
=======================================
Hits 188 188
Misses 433 433
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This pull request introduces comprehensive improvements to project infrastructure, documentation, and code organization to support the transition from
risk_controltomlrisko. The most important changes include renaming the package throughout the codebase, adding contributor and release management documentation, and implementing standardized templates for issues and pull requests. These updates enhance clarity, maintainability, and community engagement.Project Renaming and Codebase Updates
risk_controltomlriskoin example scripts (examples/plot_ai_assistance.py,examples/plot_classification.py) and updated the project name and PyPI badge inREADME.mdto reflect the new package name.Documentation and Contribution Guidelines
CONTRIBUTING.mdto guide new contributors through setup, coding standards, testing, documentation, and the pull request process.RELEASE_CHECKLIST.mdto document the step-by-step release process, including versioning, building, publishing, and post-release verification.CODE_OF_CONDUCT.mdto define community standards and enforcement policies.Issue and Pull Request Templates
.github/ISSUE_TEMPLATEand.github/pull_request_template.mdfiles to ensure consistent and complete information in community interactions..github/ISSUE_TEMPLATE/config.ymlto configure issue templates and contact links, directing users to discussions and the code of conduct.Build and CI/CD Configuration
.github/workflows/ci.yml) and type-checking inMakefileto use the newmlriskodirectory instead ofrisk_control, ensuring compatibility with the renamed package.