Skip to content

Commit 19bd00f

Browse files
author
farhadzand
committed
Enhance documentation with contributing guidelines, code of conduct, and security policy; add new validation rules for company ID, domain, and Shamsi date; refactor service provider and update tests for new rules.
1 parent 2de1370 commit 19bd00f

37 files changed

+2546
-125
lines changed

.github/FUNDING.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# These are supported funding model platforms
2+
3+
github: iamfarhad
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift package-name
8+
community_bridge: # Replace with a single Community Bridge project-name
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name
13+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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+
10+
## 🐛 Bug Description
11+
A clear and concise description of what the bug is.
12+
13+
## 🔄 Steps to Reproduce
14+
1. Go to '...'
15+
2. Click on '....'
16+
3. Scroll down to '....'
17+
4. See error
18+
19+
## ✅ Expected Behavior
20+
A clear and concise description of what you expected to happen.
21+
22+
## ❌ Actual Behavior
23+
A clear and concise description of what actually happened.
24+
25+
## 💻 Code Example
26+
```php
27+
// Please provide a minimal code example that reproduces the issue
28+
$validator = Validator::make($data, [
29+
'field' => ['rule_that_fails']
30+
]);
31+
```
32+
33+
## 🌍 Environment
34+
- **PHP Version**: [e.g. 8.1, 8.2]
35+
- **Laravel Version**: [e.g. 10.x, 11.x]
36+
- **Package Version**: [e.g. 3.1.0]
37+
- **OS**: [e.g. macOS, Ubuntu, Windows]
38+
39+
## 📋 Additional Context
40+
Add any other context about the problem here.
41+
42+
## 📸 Screenshots
43+
If applicable, add screenshots to help explain your problem.
44+
45+
## ✔️ Checklist
46+
- [ ] I have searched existing issues to ensure this is not a duplicate
47+
- [ ] I have provided a clear code example that reproduces the issue
48+
- [ ] I have included my environment details
49+
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: 🚀 Feature Request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
## 🚀 Feature Description
11+
A clear and concise description of what you want to happen.
12+
13+
## 💡 Problem/Use Case
14+
Describe the problem you're trying to solve or the use case this feature would address.
15+
16+
## 🎯 Proposed Solution
17+
A clear and concise description of your proposed solution.
18+
19+
## 🔄 Alternative Solutions
20+
Describe any alternative solutions or features you've considered.
21+
22+
## 💻 Code Example
23+
```php
24+
// Please provide an example of how you'd like to use this feature
25+
$validator = Validator::make($data, [
26+
'field' => [new ProposedRule()]
27+
]);
28+
```
29+
30+
## 🌍 Iranian/Persian Context
31+
If this feature is specific to Iranian/Persian data validation, please provide context:
32+
- What type of Iranian data does this validate?
33+
- Are there official standards or regulations this should follow?
34+
- Can you provide examples of valid/invalid data?
35+
36+
## 📋 Additional Context
37+
Add any other context, screenshots, or examples about the feature request here.
38+
39+
## ✔️ Checklist
40+
- [ ] I have searched existing issues to ensure this is not a duplicate
41+
- [ ] I have provided a clear use case for this feature
42+
- [ ] I have included code examples showing the desired API
43+
- [ ] I have considered how this fits with existing validation rules
44+

.github/ISSUE_TEMPLATE/question.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: ❓ Question
3+
about: Ask a question about using this package
4+
title: '[QUESTION] '
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
## ❓ Question
11+
What would you like to know?
12+
13+
## 🎯 What I'm Trying to Achieve
14+
Describe what you're trying to accomplish with this package.
15+
16+
## 💻 Code Example
17+
```php
18+
// Please provide your current code (if applicable)
19+
$validator = Validator::make($data, [
20+
'field' => ['your_current_rule']
21+
]);
22+
```
23+
24+
## 🔍 What I've Tried
25+
Describe what you've already tried or researched.
26+
27+
## 🌍 Environment (if relevant)
28+
- **PHP Version**: [e.g. 8.1, 8.2]
29+
- **Laravel Version**: [e.g. 10.x, 11.x]
30+
- **Package Version**: [e.g. 3.1.0]
31+
32+
## 📋 Additional Context
33+
Add any other context about your question here.
34+
35+
## ✔️ Checklist
36+
- [ ] I have checked the README documentation
37+
- [ ] I have searched existing issues for similar questions
38+
- [ ] I have provided enough context about what I'm trying to achieve
39+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Pull Request
2+
3+
## 📝 Description
4+
Brief description of what this PR does.
5+
6+
## 🎯 Type of Change
7+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
8+
- [ ] ✨ New feature (non-breaking change which adds functionality)
9+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
10+
- [ ] 📚 Documentation update
11+
- [ ] 🧪 Test improvements
12+
- [ ] 🔧 Refactoring (no functional changes)
13+
14+
## 🧪 How Has This Been Tested?
15+
- [ ] Unit tests
16+
- [ ] Integration tests
17+
- [ ] Manual testing
18+
19+
## 📋 Test Configuration
20+
- **PHP Version**:
21+
- **Laravel Version**:
22+
- **Environment**:
23+
24+
## ✔️ Checklist
25+
- [ ] My code follows the style guidelines of this project
26+
- [ ] I have performed a self-review of my own code
27+
- [ ] I have commented my code, particularly in hard-to-understand areas
28+
- [ ] I have made corresponding changes to the documentation
29+
- [ ] My changes generate no new warnings
30+
- [ ] I have added tests that prove my fix is effective or that my feature works
31+
- [ ] New and existing unit tests pass locally with my changes
32+
- [ ] Any dependent changes have been merged and published
33+
34+
## 🔗 Related Issues
35+
Fixes #(issue_number)
36+
37+
## 📸 Screenshots (if applicable)
38+
Add screenshots here if your changes affect the UI or output.
39+
40+
## 📋 Additional Notes
41+
Any additional information that would be helpful for reviewers.
42+

0 commit comments

Comments
 (0)