Skip to content

Commit df89260

Browse files
thibaultcordierthibaultcordier
authored
Merge pull request #3 from thibaultcordier/chore/github_assets
chore: project renaming + github configuration
2 parents a91ab82 + e43a2eb commit df89260

34 files changed

Lines changed: 819 additions & 127 deletions

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: ['bug']
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
A clear and concise description of what the bug is.
11+
12+
## Steps to Reproduce
13+
1. Go to '...'
14+
2. Click on '....'
15+
3. Scroll down to '....'
16+
4. See error
17+
18+
## Expected Behavior
19+
A clear and concise description of what you expected to happen.
20+
21+
## Actual Behavior
22+
A clear and concise description of what actually happened.
23+
24+
## Environment
25+
- **OS**: [e.g. macOS, Ubuntu, Windows]
26+
- **Python Version**: [e.g. 3.9, 3.10, 3.11, 3.12, 3.13]
27+
- **Package Version**: [e.g. 0.1.0]
28+
- **Dependencies**: [List any relevant dependencies]
29+
30+
## Additional Context
31+
Add any other context about the problem here, such as:
32+
- Error messages or stack traces
33+
- Screenshots (if applicable)
34+
- Related issues or pull requests
35+
36+
## Checklist
37+
- [ ] I have searched existing issues to avoid duplicates
38+
- [ ] I have provided all the requested information
39+
- [ ] I can reproduce this issue consistently

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: GitHub Discussions
4+
url: https://github.com/thibaultcordier/risk-control/discussions
5+
about: Please ask and answer questions here.
6+
- name: Code of Conduct
7+
url: https://github.com/thibaultcordier/risk-control/blob/main/CODE_OF_CONDUCT.md
8+
about: Please read our Code of Conduct before participating.

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Documentation
3+
about: Report documentation issues or suggest improvements
4+
title: '[DOCS] '
5+
labels: ['documentation']
6+
assignees: ''
7+
---
8+
9+
## Documentation Issue
10+
A clear and concise description of what documentation issue you're reporting or what improvement you're suggesting.
11+
12+
## Current Documentation
13+
- **Page/Section**: [e.g. README.md, API docs, Installation guide]
14+
- **URL**: [If applicable]
15+
- **Current Content**: [Brief description or quote of current content]
16+
17+
## Problem/Improvement
18+
- **Issue**: [e.g. Missing information, Unclear explanation, Outdated content]
19+
- **Impact**: [e.g. Users can't install the package, API usage is unclear]
20+
21+
## Suggested Changes
22+
A clear and concise description of what should be changed or added.
23+
24+
## Examples
25+
If applicable, provide examples of how the documentation should look:
26+
```python
27+
# Example code or documentation format
28+
```
29+
30+
## Additional Context
31+
- **User Type**: [e.g. Beginner, Advanced user, Contributor]
32+
- **Use Case**: [e.g. Installation, API usage, Contributing]
33+
34+
## Checklist
35+
- [ ] I have searched existing issues to avoid duplicates
36+
- [ ] I have checked the current documentation
37+
- [ ] I'm willing to help improve the documentation if needed

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: ['enhancement']
6+
assignees: ''
7+
---
8+
9+
## Problem Statement
10+
A clear and concise description of what problem this feature would solve. For example: "I'm always frustrated when [...]"
11+
12+
## Proposed Solution
13+
A clear and concise description of what you want to happen.
14+
15+
## Alternative Solutions
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
## Use Case
19+
Describe a specific use case where this feature would be beneficial:
20+
- **Who**: [e.g. Data scientists, Researchers, ML engineers]
21+
- **What**: [e.g. Risk assessment, Model calibration, Decision making]
22+
- **When**: [e.g. During model training, At inference time, For validation]
23+
24+
## Expected Impact
25+
- **Performance**: [e.g. Faster execution, Better accuracy, Reduced memory usage]
26+
- **Usability**: [e.g. Easier to use, More intuitive, Better documentation]
27+
- **Compatibility**: [e.g. Works with existing code, Backward compatible]
28+
29+
## Implementation Ideas
30+
If you have any ideas about how this could be implemented, please share them here.
31+
32+
## Additional Context
33+
Add any other context or screenshots about the feature request here.
34+
35+
## Checklist
36+
- [ ] I have searched existing issues to avoid duplicates
37+
- [ ] This feature aligns with the project's goals
38+
- [ ] I'm willing to help implement this feature if needed

‎.github/pull_request_template.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
## 📝 Description
2+
A clear and concise description of what this PR does and why it's needed.
3+
4+
## 🔄 Type of Change
5+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
6+
- [ ] ✨ New feature (non-breaking change which adds functionality)
7+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
8+
- [ ] 📚 Documentation update
9+
- [ ] ♻️ Code refactoring (no functional changes)
10+
- [ ] ⚡ Performance improvement
11+
- [ ] 🧪 Test updates
12+
- [ ] 🔧 CI/CD improvements
13+
- [ ] 🎨 Style/formatting changes
14+
15+
## 🧪 Testing
16+
- [ ] ✅ Unit tests added/updated
17+
- [ ] ✅ Integration tests added/updated (if applicable)
18+
- [ ] ✅ All tests pass locally
19+
- [ ] ✅ CI/CD pipeline passes
20+
- [ ] ✅ Manual testing completed
21+
- [ ] ✅ Test coverage maintained or improved
22+
23+
## 📚 Documentation
24+
- [ ] 📖 Code documentation updated (docstrings, comments)
25+
- [ ] 📖 README updated (if needed)
26+
- [ ] 📖 API documentation updated (if applicable)
27+
- [ ] 📖 Examples updated (if applicable)
28+
- [ ] 📖 CHANGELOG updated
29+
30+
## 🔍 Code Quality
31+
- [ ] ✅ Code follows style guidelines (Ruff)
32+
- [ ] ✅ Type hints added/updated (MyPy)
33+
- [ ] ✅ Self-review completed
34+
- [ ] ✅ Comments added for complex code
35+
- [ ] ✅ No linting errors or warnings
36+
- [ ] ✅ No type checking errors
37+
38+
## 🚀 Breaking Changes
39+
If this PR introduces breaking changes, please describe:
40+
- What changed
41+
- Why it changed
42+
- Migration guide (if applicable)
43+
44+
## 📋 Checklist
45+
- [ ] ✅ I have read the [Contributing Guidelines](CONTRIBUTING.md)
46+
- [ ] ✅ I have followed the project's code style
47+
- [ ] ✅ I have tested my changes thoroughly
48+
- [ ] ✅ I have updated documentation as needed
49+
- [ ] ✅ My changes generate no new warnings
50+
- [ ] ✅ I have added tests that prove my fix is effective or that my feature works
51+
- [ ] ✅ New and existing unit tests pass locally with my changes
52+
- [ ] ✅ Any dependent changes have been merged and published
53+
54+
## 🔗 Related Issues
55+
Closes #[issue number]
56+
Related to #[issue number]
57+
58+
## 📸 Screenshots (if applicable)
59+
Add screenshots to help explain your changes.
60+
61+
## 🧪 How to Test
62+
Instructions for testing this PR:
63+
1. Step 1
64+
2. Step 2
65+
3. Step 3
66+
67+
## 📝 Additional Notes
68+
Any additional information that reviewers should know.

‎.github/workflows/ci.yml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,7 @@ jobs:
118118

119119
- name: Run bandit security scan
120120
run: |
121-
uv run pip install bandit
122-
uv run bandit -r risk_control/ -f json -o bandit-report.json || true
121+
uv run bandit -r mlrisko/ -f json -o bandit-report.json || true
123122
124123
- name: Run pip-audit for dependency vulnerabilities
125124
run: |

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ coverage.xml
2626

2727
*.DS_Store
2828

29-
_risk_control
29+
_mlrisko
3030
docs/generated
3131
site

‎CODE_OF_CONDUCT.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to a positive environment for our
15+
community include:
16+
17+
* Demonstrating empathy and kindness toward other people
18+
* Being respectful of differing opinions, viewpoints, and experiences
19+
* Giving and gracefully accepting constructive feedback
20+
* Accepting responsibility and apologizing to those affected by our mistakes
21+
* Focusing on what is best for the overall community
22+
23+
Examples of unacceptable behavior include:
24+
25+
* The use of sexualized language or imagery, and sexual attention or advances
26+
* Trolling, insulting or derogatory comments, and personal or political attacks
27+
* Public or private harassment
28+
* Publishing others' private information without explicit permission
29+
* Other conduct which could reasonably be considered inappropriate
30+
31+
## Enforcement Responsibilities
32+
33+
Community leaders are responsible for clarifying and enforcing our standards of
34+
acceptable behavior and will take appropriate and fair corrective action in
35+
response to any behavior that they deem inappropriate, threatening, offensive,
36+
or harmful.
37+
38+
## Scope
39+
40+
This Code of Conduct applies within all community spaces, and also applies when
41+
an individual is officially representing the community in public spaces.
42+
43+
## Enforcement
44+
45+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
46+
reported to the community leaders responsible for enforcement at
47+
[INSERT CONTACT METHOD]. All complaints will be reviewed and investigated
48+
promptly and fairly.
49+
50+
## Attribution
51+
52+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
53+
version 2.0, available at
54+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

0 commit comments

Comments
 (0)