⭐ Updated contribution policy and docs

hasnimehdi91 · hasnimehdi91 · commit 4e0fea7445b8 · 2025-02-16T17:21:14.000+01:00
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -6,37 +6,36 @@ labels: 'bug'
 assignees: ''
 ---
 
-## Bug Description
+## 🐛 Bug Description
 <!-- A clear and concise description of what the bug is -->
 
-## Steps To Reproduce
+## 📝 Steps To Reproduce
 1. 
 2. 
 3. 
 
-## Expected Behavior
+## ✅ Expected Behavior
 <!-- What you expected to happen -->
 
-## Actual Behavior
+## ❌ Actual Behavior
 <!-- What actually happened -->
 
-## Environment
+## 🔧 Environment
 - NETCore.Keycloak Version:
 - .NET Version:
 - Keycloak Server Version:
 - Operating System:
 
-## Additional Context
+## 📚 Additional Context
 <!-- Add any other context about the problem here -->
 
-## Possible Solution
+## 💡 Possible Solution
 <!-- If you have suggestions on how to fix the bug -->
 
-## Screenshots
+## 📸 Screenshots
 <!-- If applicable, add screenshots to help explain your problem -->
 
-## Logs
+## 📊 Logs
 <!-- If applicable, add relevant log outputs -->
 ```
 [Paste logs here]
-```
diff --git a/.github/ISSUE_TEMPLATE/docs_improvement.md b/.github/ISSUE_TEMPLATE/docs_improvement.md
@@ -6,22 +6,22 @@ labels: 'documentation'
 assignees: ''
 ---
 
-## Documentation Area
+## 📚 Documentation Area
 <!-- Specify which documentation needs improvement (API docs, README, Wiki, etc.) -->
 
-## Current Documentation
+## 📝 Current Documentation
 <!-- Describe what's currently in the documentation -->
 
-## Proposed Changes
+## ✨ Proposed Changes
 <!-- Describe what should be changed or added -->
 
-## Reason for Change
+## 🎯 Reason for Change
 <!-- Why is this change needed? -->
 
-## Additional Context
+## 📋 Additional Context
 <!-- Add any other context about the documentation improvement -->
 
-## Checklist
+## ✅ Checklist
 - [ ] Checked for existing documentation
 - [ ] Provided clear examples (if applicable)
 - [ ] Checked for technical accuracy
diff --git a/.github/ISSUE_TEMPLATE/refactor_proposal.md b/.github/ISSUE_TEMPLATE/refactor_proposal.md
@@ -6,27 +6,27 @@ labels: 'refactor'
 assignees: ''
 ---
 
-## Refactor Scope
+## 🔄 Refactor Scope
 <!-- Describe which part of the codebase needs refactoring -->
 
-## Current Implementation
+## 📝 Current Implementation
 <!-- Describe the current implementation and its issues -->
 
-## Proposed Changes
+## ✨ Proposed Changes
 <!-- Describe your proposed refactoring changes -->
 
-## Benefits
+## 🎯 Benefits
 <!-- List the benefits of this refactoring -->
 
-## Potential Risks
+## ⚠️ Potential Risks
 <!-- Describe any potential risks or challenges -->
 
-## Implementation Plan
+## 📋 Implementation Plan
 - [ ] Unit tests for new implementation
 - [ ] Refactor implementation
 - [ ] Update documentation
 - [ ] Performance testing (if applicable)
 - [ ] Migration guide (if breaking changes)
 
-## Additional Context
+## 📚 Additional Context
 <!-- Add any other context about the refactoring proposal -->
diff --git a/.github/PULL_REQUEST_TEMPLATE/bugfix.md b/.github/PULL_REQUEST_TEMPLATE/bugfix.md
@@ -5,30 +5,30 @@ title: '[BUGFIX] '
 labels: 'bug'
 ---
 
-## Bug Description
+## 🐛 Bug Description
 <!-- Link to the bug report issue and briefly describe the bug -->
 
-## Fix Description
+## 🔧 Fix Description
 <!-- Describe your fix and how it addresses the issue -->
 
-## Root Cause
+## 🔍 Root Cause
 <!-- Explain what caused the bug -->
 
-## Testing
+## 🧪 Testing
 <!-- Describe how you tested the fix -->
 
-## Regression Tests
+## ✅ Regression Tests
 <!-- Describe the tests you've added to prevent regression -->
 
-## Checklist
+## 📋 Checklist
 - [ ] I have followed the code style guidelines
 - [ ] I have added regression tests
 - [ ] I have updated documentation if needed
 - [ ] I have added/updated XML documentation comments if needed
 - [ ] I have verified the fix in my local environment
 
-## Additional Context
+## 📚 Additional Context
 <!-- Add any other context about the fix here -->
 
-## Screenshots
+## 📸 Screenshots
 <!-- If applicable, add screenshots to show the fix -->
diff --git a/.github/PULL_REQUEST_TEMPLATE/docs.md b/.github/PULL_REQUEST_TEMPLATE/docs.md
@@ -5,13 +5,13 @@ title: '[DOCS] '
 labels: 'documentation'
 ---
 
-## Documentation Changes
+## 📚 Documentation Changes
 <!-- Describe the documentation changes made -->
 
-## Related Issue
+## 🔗 Related Issue
 <!-- Link to related documentation issue if applicable -->
 
-## Type of Change
+## 📋 Type of Change
 <!-- What type of documentation change is this? -->
 - [ ] New documentation
 - [ ] Documentation update
@@ -20,15 +20,15 @@ labels: 'documentation'
 - [ ] Add examples
 - [ ] Other (please describe)
 
-## Checklist
+## ✅ Checklist
 - [ ] I have checked for technical accuracy
 - [ ] I have tested all code examples (if any)
 - [ ] I have checked for proper formatting
 - [ ] I have verified all links work
 - [ ] I have run spellcheck
 
-## Preview
+## 🖼️ Preview
 <!-- If applicable, add screenshots or links to preview the changes -->
 
-## Additional Notes
+## 📝 Additional Notes
 <!-- Any additional information that reviewers should know -->
diff --git a/.github/PULL_REQUEST_TEMPLATE/feature.md b/.github/PULL_REQUEST_TEMPLATE/feature.md
@@ -5,34 +5,34 @@ title: '[FEATURE] '
 labels: 'enhancement'
 ---
 
-## Feature Description
+## ✨ Feature Description
 <!-- Describe the feature you've implemented -->
 
-## Related Issue
+## 🔗 Related Issue
 <!-- Link to the feature request issue -->
 
-## Implementation Details
+## 🛠️ Implementation Details
 <!-- Provide details about your implementation -->
 
-## Testing
+## 🧪 Testing
 <!-- Describe the tests you've added -->
 
-## Documentation
+## 📚 Documentation
 <!-- List documentation changes made -->
 
-## Breaking Changes
+## ⚠️ Breaking Changes
 <!-- List any breaking changes and migration steps -->
 
-## Checklist
+## ✅ Checklist
 - [ ] I have followed the code style guidelines
 - [ ] I have added unit tests
 - [ ] I have updated documentation
 - [ ] I have added XML documentation comments
 - [ ] I have tested the feature thoroughly
 - [ ] I have added example code (if applicable)
 
-## Screenshots
+## 📸 Screenshots
 <!-- If applicable, add screenshots to showcase the feature -->
 
-## Additional Notes
+## 📝 Additional Notes
 <!-- Any additional information that reviewers should know -->
diff --git a/.github/PULL_REQUEST_TEMPLATE/hotfix.md b/.github/PULL_REQUEST_TEMPLATE/hotfix.md
@@ -5,33 +5,33 @@ title: '[HOTFIX] '
 labels: 'hotfix'
 ---
 
-## Emergency Description
+## 🚨 Emergency Description
 <!-- Describe the critical issue being fixed -->
 
-## Impact
+## 💥 Impact
 <!-- Describe the impact of the issue on users -->
 
-## Fix Description
+## 🔧 Fix Description
 <!-- Describe your emergency fix -->
 
-## Risk Assessment
+## ⚠️ Risk Assessment
 <!-- Assess the risk of this hotfix -->
 
-## Testing
+## 🧪 Testing
 <!-- Describe how you tested the fix -->
 
-## Verification Steps
+## ✅ Verification Steps
 <!-- Steps for reviewers to verify the fix -->
 
-## Checklist
+## 📋 Checklist
 - [ ] I have followed the code style guidelines
 - [ ] I have added tests
 - [ ] I have updated documentation if needed
 - [ ] I have tested in production-like environment
 - [ ] I have considered potential side effects
 
-## Rollback Plan
+## 🔄 Rollback Plan
 <!-- Describe how to rollback this change if needed -->
 
-## Additional Context
+## 📚 Additional Context
 <!-- Add any other context about the hotfix here -->
diff --git a/NETCore.Keycloak.Client/README.md b/NETCore.Keycloak.Client/README.md
@@ -87,7 +87,7 @@ var token = await keycloakClient.Auth.GetClientCredentialsTokenAsync(
 var users = await keycloakClient.Users.GetAsync(
     "your-realm",
     token.AccessToken,
-    new KcUserFilter { MaxResults = 10 });
+    new KcUserFilter { Max = 10 });
 ```
 ## 📄 License
 
