Skip to content

Commit 8e95971

Browse files
committed
Add solution folders, workflows, and configuration files for CI/CD, code coverage, and contribution guidelines
1 parent f9479ac commit 8e95971

22 files changed

Lines changed: 935 additions & 18 deletions

.gitattributes

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# .gitattributes for SGuard.DataAnnotations
2+
# Ensure consistent line endings and text encoding
3+
* text=auto
4+
*.cs diff=csharp
5+
*.resx text
6+
*.md text
7+
*.yml text
8+
*.json text
9+
*.sln text
10+
*.csproj text
11+
*.runsettings text
12+

.github/BRANCH_NAMING_GUIDLINES.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Branch Naming Guidelines
2+
3+
When creating a new branch, please follow this naming convention to maintain consistency and clarity in communication regarding the nature of changes.
4+
5+
## Protected Branches
6+
7+
These branches are protected and can only be updated by repository administrators. As a contributor, do **not** commit directly to these branches.
8+
9+
| Branch Name | Description |
10+
| ----------- | -------------------------------------------------------------------------------------- |
11+
| `main` | The stable, production-ready version of the website. |
12+
| `dev` | The development branch containing features and bug fixes not yet ready for production. |
13+
14+
## Contributing Branches
15+
16+
These branches are open for contributions from all contributors. Follow these naming conventions when creating a new branch:
17+
18+
| Branch Name | Description |
19+
| ------------ | ------------------------------------------------------------------------------------------------------ |
20+
| `feat/x` | A branch for adding new features or enhancing functionality. Replace `x` with a short description. |
21+
| `fix/x` | A branch for fixing bugs. Replace `x` with a description of the issue being addressed. |
22+
| `docs/x` | A branch for documentation updates. Replace `x` with a description of the documentation being updated. |
23+
| `style/x` | A branch for code style changes (formatting, spacing, etc.). Replace `x` with the style change. |
24+
| `refactor/x` | A branch for code refactoring that doesn’t change functionality. Replace `x` with a description. |
25+
| `perf/x` | A branch for performance improvements. Replace `x` with the specific performance enhancement. |
26+
| `test/x` | A branch for adding or modifying tests. Replace `x` with the test being added or modified. |
27+
| `chore/x` | A branch for routine tasks or maintenance (e.g., upgrading dependencies). Replace `x` with the task. |
28+
29+
## Examples
30+
31+
Here are a few examples of valid branch names:
32+
33+
- `feat/navbar` - New feature for the navbar.
34+
- `fix/login` - Bug fix for the login functionality.
35+
- `docs/readme` - Update to the README documentation.
36+
- `style/formatting` - Code style formatting changes.
37+
- `refactor/database` - Refactor the database connection handling.
38+
- `test/authentication` - Tests for the authentication service.
39+
- `chore/dependencies` - Update dependencies.

.github/CODE_OF_CONDUCT.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# .NET Foundation Code of Conduct
2+
3+
This project has adopted the code of conduct defined by the .NET Foundation to foster an open and welcoming environment for contributors and users.
4+
5+
## Our Pledge
6+
7+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to creating a positive environment include:
12+
- Using welcoming and inclusive language
13+
- Being respectful of differing viewpoints and experiences
14+
- Gracefully accepting constructive criticism
15+
- Focusing on what is best for the community
16+
- Showing empathy towards other community members
17+
18+
Examples of unacceptable behavior by participants include:
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct, which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
## Scope
30+
31+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
32+
33+
## Enforcement
34+
35+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [selcukgural@gmail.com]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
36+
37+
## Attribution
38+
39+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) and the .NET Foundation Code of Conduct.
40+
41+
---
42+
43+
For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/about/code-of-conduct).

.github/CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing to SGuard.DataAnnotations
2+
3+
Thank you for your interest in contributing to SGuard! We welcome contributions from everyone. This guide will help you get started.
4+
5+
## How to Contribute
6+
7+
1. **Fork the repository**
8+
- Click the "Fork" button at the top of the GitHub page to create your own copy.
9+
2. **Clone your fork**
10+
- `git clone https://github.com/selcukgural/SGuard.DataAnnotations.git`
11+
3. **Create a branch**
12+
- `git checkout -b my-feature-branch`
13+
4. **Make your changes**
14+
- Add your improvements, bug fixes, or documentation updates.
15+
5. **Test your changes**
16+
- Ensure all tests pass and your code is robust.
17+
6. **Commit and push**
18+
- `git commit -am "Describe your change"`
19+
- `git push origin my-feature-branch`
20+
7. **Open a Pull Request**
21+
- Go to your fork on GitHub and click "New Pull Request."
22+
23+
## Code Style
24+
- Follow .NET and C# best practices.
25+
- Write clear, concise, and well-documented code.
26+
- Add XML comments for public APIs.
27+
28+
## Reporting Issues
29+
- Use GitHub Issues to report bugs, request features, or ask questions.
30+
- Please provide as much detail as possible.
31+
32+
## Community Standards
33+
- Be respectful and inclusive.
34+
- Follow the [Code of Conduct](CODE_OF_CONDUCT.md).
35+
36+
## License
37+
By contributing, you agree that your contributions will be licensed under the MIT License.
38+
39+
---
40+
41+
Thank you for helping make SGuard.DataAnnotations better!

.github/FUNDING.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Example: Enable GitHub Sponsors
2+
# github: [your-github-username]
3+
# open_collective: your-collective
4+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
labels: bug
5+
---
6+
7+
**Describe the bug**
8+
A clear and concise description of what the bug is.
9+
10+
**To Reproduce**
11+
Steps to reproduce the behavior:
12+
1. Go to '...'
13+
2. Click on '....'
14+
3. Scroll down to '....'
15+
4. See error
16+
17+
**Expected behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Screenshots**
21+
If applicable, add screenshots to help explain your problem.
22+
23+
**Environment (please complete the following information):**
24+
- OS: [e.g. Windows, macOS, Linux]
25+
- .NET version: [6.0, 7.0, 8.0, 9.0]
26+
- Library version: [e.g. 1.0.0]
27+
28+
**Additional context**
29+
Add any other context about the problem here.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea or improvement for this project
4+
labels: enhancement
5+
---
6+
7+
**Where to open feature requests:**
8+
Please open feature requests at [the GitHub issue page](https://github.com/selcukgural/SGuard.DataAnnotations/issues/new/choose).
9+
10+
**Contact:**
11+
For urgent or sensitive feature discussions, you can also contact the maintainer at selcukgural@gmail.com.
12+
13+
**Is your feature request related to a problem? Please describe.**
14+
A clear and concise description of what the problem is. For example, "I'm always frustrated when..."
15+
16+
**Describe the solution you'd like**
17+
A clear and concise description of what you want to happen. If possible, provide example code or usage scenarios.
18+
19+
**Describe alternatives you've considered**
20+
A clear and concise description of any alternative solutions or features you've considered.
21+
22+
**Additional context**
23+
Add any other context, screenshots, or references (e.g., links to similar features in other libraries) about the feature request here.
24+
25+
**Who would benefit from this feature?**
26+
Describe the target users or scenarios that would benefit from this feature.
27+
28+
**Are you willing to help implement this feature?**
29+
- [ ] Yes
30+
- [ ] No
31+
- [ ] Maybe (please explain)

.github/ISSUE_TEMPLATE/feedback.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: 📢 Feedback
3+
about: Provide feedback for this project
4+
title: "📢 Feedback: Enter a short description of the issue"
5+
labels: "feedback"
6+
assignees: "dileepadev"
7+
---
8+
9+
## 📢 Feedback
10+
11+
### 📜 Description
12+
13+
<!-- [REQUIRED] Briefly describe the feedback. -->
14+
15+
### 🔗 Related Issues or PRs
16+
17+
<!-- [OPTIONAL] Link to any related issues or pull requests. Remove if not needed. -->
18+
19+
### 📝 Additional Information
20+
21+
<!-- [OPTIONAL] Any additional context about the feedback here. Remove if not needed. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Pull Request
2+
3+
Thank you for your contribution!
4+
5+
## Description
6+
Please provide a detailed summary of your changes, including:
7+
- The motivation and context for the change
8+
- The main functionality or fix introduced
9+
- Any relevant design decisions or architectural changes
10+
- References to related issues (e.g. Fixes #123)
11+
- Impact on existing code, APIs, or documentation
12+
- If applicable, describe how this aligns with .NET best practices (e.g. naming conventions, exception handling, extensibility, testability)
13+
14+
## Type of change
15+
- [ ] Bug fix
16+
- [ ] New feature
17+
- [ ] Breaking change
18+
- [ ] Documentation update
19+
20+
## Checklist
21+
- [ ] My code follows the style guidelines of this project
22+
- [ ] I have performed a self-review of my own code
23+
- [ ] I have commented my code, particularly in hard-to-understand areas
24+
- [ ] I have made corresponding changes to the documentation
25+
- [ ] My changes generate no new warnings
26+
- [ ] I have added tests that prove my fix is effective or that my feature works
27+
- [ ] New and existing unit tests pass locally with my changes

.github/SECURITY.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Security Policy
2+
3+
The [community](https://github.com/selcukgural/SGuard.DataAnnotations) project team takes security issues very seriously. We appreciate your efforts to responsibly disclose any security vulnerabilities you find.
4+
5+
## Reporting a Vulnerability
6+
7+
If you discover a security vulnerability, please email **<selcukgural@gmail.com>**. Please do not create a public issue for the vulnerability.
8+
9+
Your email should include the following information:
10+
11+
- A description of the vulnerability
12+
- Steps to reproduce the vulnerability
13+
- Possible impact of the vulnerability
14+
- Any suggested mitigation or remediation steps
15+
16+
We will respond to your email as soon as possible and work with you to address any security issues.
17+
18+
## Bug Bounty Program
19+
20+
At this time, we do not offer a bug bounty program. If we decide to introduce one in the future, details will be shared here.
21+
22+
## Maintainer Responsibilities
23+
24+
Maintainers are responsible for the security of the project. This includes:
25+
26+
- Responding to security reports in a timely manner
27+
- Investigating reported vulnerabilities
28+
- Developing and releasing patches for confirmed vulnerabilities
29+
- Communicating with the reporting party as the issue is addressed
30+
- Regularly reviewing and auditing the security of the project
31+
32+
## Disclosures
33+
34+
- We will acknowledge receipt of your report within one business day as soon as possible.
35+
- We will confirm the vulnerability and determine its impact.
36+
- We will release a fix as soon as possible, depending on the complexity of the issue.
37+
- We will communicate the vulnerability and any patches or workarounds to our users.
38+
39+
Thank you for your help in making the [community](https://github.com/selcukgural/SGuard.DataAnnotations) project a more secure place.

0 commit comments

Comments
 (0)