Skip to content

Commit 2fae198

Browse files
hinxcodehinxcode
authored
Merge pull request #22 from hinxcode/contributions
Contributions
2 parents 524c9bb + c53a892 commit 2fae198

29 files changed

+1885
-273
lines changed

‎.flake8‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[flake8]
2+
max-line-length = 88
3+
extend-ignore = E203, E501
4+
exclude =
5+
.git,
6+
__pycache__,
7+
venv,
8+
.venv,
9+
env,
10+
.env,
11+
build,
12+
dist,
13+
node_modules,
14+
.pytest_cache,
15+
.mypy_cache
16+
max-complexity = 10
17+

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug to help us improve
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
11+
A clear and concise description of what the bug is.
12+
13+
## Steps to Reproduce
14+
15+
1. Go to '...'
16+
2. Run command '...'
17+
3. Click on '...'
18+
4. See error
19+
20+
## Expected Behavior
21+
22+
A clear and concise description of what you expected to happen.
23+
24+
## Actual Behavior
25+
26+
What actually happened instead.
27+
28+
## Screenshots/Logs
29+
30+
If applicable, add screenshots or error logs to help explain your problem.
31+
32+
```
33+
Paste error logs here
34+
```
35+
36+
## Environment
37+
38+
- **OS**: [e.g., macOS 13.0, Ubuntu 22.04, Windows 11]
39+
- **Python Version**: [e.g., 3.10.5]
40+
- **Node.js Version**: [e.g., 18.12.0]
41+
- **Collection Type**: [photographs/maps/documents]
42+
- **CLIP Model**: [e.g., openai/clip-vit-base-patch32]
43+
- **Browser** (if frontend issue): [e.g., Chrome 120, Firefox 121]
44+
45+
## Configuration
46+
47+
Please share relevant parts of your `config.json` (remove any sensitive information):
48+
49+
```json
50+
{
51+
"collection_type": "photographs",
52+
"model_config": {
53+
"clip_model": "openai/clip-vit-base-patch32"
54+
}
55+
}
56+
```
57+
58+
## Additional Context
59+
60+
Add any other context about the problem here.
61+
62+
## Possible Solution (Optional)
63+
64+
If you have ideas about what might be causing the issue or how to fix it, please share them here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: GitHub Discussions
4+
url: https://github.com/hinxcode/digital-collections-explorer/discussions
5+
about: Ask questions, share ideas, and discuss with the community

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
name: Documentation Improvement
3+
about: Suggest improvements to documentation
4+
title: '[DOCS] '
5+
labels: documentation
6+
assignees: ''
7+
---
8+
9+
## Documentation Issue
10+
11+
What documentation needs improvement?
12+
13+
- [ ] README.md
14+
- [ ] CONTRIBUTING.md
15+
- [ ] Code comments
16+
- [ ] API documentation
17+
- [ ] Configuration guide
18+
- [ ] Tutorial or guide
19+
- [ ] Error messages
20+
- [ ] Other (please specify)
21+
22+
## Location
23+
24+
Where is the documentation issue located?
25+
26+
- File: [e.g., README.md]
27+
- Section: [e.g., "Quick Start Guide"]
28+
- Line numbers (if applicable): [e.g., lines 45-52]
29+
30+
## Problem Description
31+
32+
What's unclear, incorrect, or missing?
33+
34+
## Suggested Improvement
35+
36+
How would you improve it? Provide:
37+
- Corrected text
38+
- Additional explanations
39+
- Code examples
40+
- Diagrams or screenshots
41+
42+
## Affected Users
43+
44+
Who would benefit from this improvement?
45+
46+
- [ ] New users/first-time setup
47+
- [ ] Contributors/developers
48+
- [ ] Researchers
49+
- [ ] System administrators
50+
- [ ] End users
51+
52+
## Additional Context
53+
54+
Any other helpful information or examples.
55+
56+
## Willingness to Contribute
57+
58+
- [ ] I can submit a PR to fix this
59+
- [ ] I need help making the changes
60+
- [ ] I'm just reporting the issue

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
11+
A clear and concise description of the feature you'd like to see.
12+
13+
## Problem/Motivation
14+
15+
What problem does this feature solve? What use case does it address?
16+
17+
Example: "I'm always frustrated when [...]" or "It would be useful to [...]"
18+
19+
## Proposed Solution
20+
21+
Describe how you envision this feature working. Include:
22+
- User interface changes (if applicable)
23+
- API changes (if applicable)
24+
- Configuration options (if applicable)
25+
26+
## Alternative Solutions
27+
28+
Have you considered any alternative approaches? What are the pros/cons?
29+
30+
## Use Case
31+
32+
Describe a specific scenario where this feature would be useful:
33+
34+
1. User wants to...
35+
2. They would...
36+
3. The result would be...
37+
38+
## Collection Type
39+
40+
Which collection type(s) would benefit from this feature?
41+
- [ ] All collection types
42+
- [ ] Photographs
43+
- [ ] Maps
44+
- [ ] Documents
45+
46+
## Implementation Ideas (Optional)
47+
48+
If you have technical ideas about how to implement this:
49+
- Architecture considerations
50+
- Libraries or tools that could help
51+
- Potential challenges
52+
53+
## Examples
54+
55+
If similar features exist in other tools or projects, please link to them:
56+
- Example 1: [link]
57+
- Example 2: [link]
58+
59+
## Additional Context
60+
61+
Add any other context, mockups, or screenshots about the feature request here.
62+
63+
## Willingness to Contribute
64+
65+
- [ ] I'm willing to work on this feature myself
66+
- [ ] I can help test this feature
67+
- [ ] I can provide feedback during development
68+
- [ ] I'm just suggesting the idea

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
## Description
2+
3+
<!-- Provide a clear and concise description of your changes -->
4+
5+
## Motivation and Context
6+
7+
<!-- Why is this change needed? What problem does it solve? -->
8+
<!-- If it fixes an open issue, please link to the issue here using #issue_number -->
9+
10+
Fixes #(issue)
11+
12+
## Type of Change
13+
14+
<!-- Mark the relevant option with an "x" -->
15+
16+
- [ ] Bug fix (non-breaking change that fixes an issue)
17+
- [ ] New feature (non-breaking change that adds functionality)
18+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
19+
- [ ] Documentation update
20+
- [ ] Code refactoring (no functional changes)
21+
- [ ] Performance improvement
22+
- [ ] Research contribution (new models, evaluation methods, etc.)
23+
- [ ] Other (please describe):
24+
25+
## Component(s) Affected
26+
27+
<!-- Mark all that apply -->
28+
29+
- [ ] Backend (Python/FastAPI)
30+
- [ ] Frontend - Photographs
31+
- [ ] Frontend - Maps
32+
- [ ] Frontend - Documents
33+
- [ ] CLIP/ML models
34+
- [ ] Configuration
35+
- [ ] Documentation
36+
- [ ] Tests
37+
- [ ] Build/deployment
38+
39+
## Changes Made
40+
41+
<!-- List the main changes in bullet points -->
42+
43+
- Change 1
44+
- Change 2
45+
- Change 3
46+
47+
## Testing
48+
49+
### How Has This Been Tested?
50+
51+
<!-- Describe the tests you ran and how to reproduce them -->
52+
53+
- [ ] Test A: Description
54+
- [ ] Test B: Description
55+
56+
### Test Configuration
57+
58+
- **Collection type tested**: [photographs/maps/documents/all]
59+
- **Python version**: [e.g., 3.10]
60+
- **Node version**: [e.g., 18]
61+
- **OS**: [e.g., macOS, Ubuntu]
62+
- **CLIP model**: [e.g., openai/clip-vit-base-patch32]
63+
64+
## Screenshots (if applicable)
65+
66+
<!-- Add screenshots to demonstrate UI changes -->
67+
68+
| Before | After |
69+
|--------|-------|
70+
| (screenshot) | (screenshot) |
71+
72+
## Checklist
73+
74+
<!-- Mark completed items with an "x" -->
75+
76+
### Code Quality
77+
78+
- [ ] My code follows the project's coding standards
79+
- [ ] I have run `black .` and `isort .` on Python code
80+
- [ ] I have run `npm run lint` on frontend code (if applicable)
81+
- [ ] I have performed a self-review of my own code
82+
- [ ] I have commented my code, particularly in hard-to-understand areas
83+
- [ ] My changes generate no new warnings or errors
84+
85+
### Testing
86+
87+
- [ ] I have added tests that prove my fix is effective or that my feature works
88+
- [ ] New and existing unit tests pass locally with my changes
89+
- [ ] I have tested this locally with actual data
90+
91+
### Documentation
92+
93+
- [ ] I have updated the documentation accordingly
94+
- [ ] I have updated the README if needed
95+
- [ ] I have added docstrings to new functions/classes
96+
- [ ] I have updated `config.json` documentation if config changes were made
97+
98+
### Dependencies
99+
100+
- [ ] I have updated `requirements.txt` (if Python dependencies changed)
101+
- [ ] I have updated `package.json` (if Node dependencies changed)
102+
- [ ] I have documented any new configuration options
103+
104+
### Research (if applicable)
105+
106+
- [ ] I have included references to relevant papers or research
107+
- [ ] I have shared evaluation results or benchmarks
108+
- [ ] I have included information about datasets used
109+
- [ ] I have documented model training procedures
110+
111+
## Breaking Changes
112+
113+
<!-- If this PR contains breaking changes, describe them here -->
114+
<!-- Include migration instructions for users -->
115+
116+
None / (describe breaking changes)
117+
118+
## Additional Notes
119+
120+
<!-- Any additional information that reviewers should know -->
121+
122+
## Reviewers Checklist (for maintainers)
123+
124+
- [ ] Code quality and style compliance
125+
- [ ] Test coverage adequate
126+
- [ ] Documentation complete
127+
- [ ] No security concerns
128+
- [ ] Performance implications acceptable
129+
- [ ] Breaking changes documented

0 commit comments

Comments
 (0)