Skip to content

Commit c896f98

Browse files
SeramisSeramis
committed
GitHub related improvements. Pipelines, documents, licenses, bug/feature templates, etc.
1 parent 36b974a commit c896f98

File tree

9 files changed

+305
-4
lines changed

9 files changed

+305
-4
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
name: "🐛 Bug Report"
2+
description: "Report a bug or unexpected behavior in the project."
3+
title: "[Bug]: "
4+
labels:
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for taking the time to report a bug! Please provide as much detail as possible.
11+
12+
- type: checkboxes
13+
id: preconditions
14+
attributes:
15+
label: Things to check
16+
options:
17+
- label: I have searched the **existing issues** for this bug
18+
required: true
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: bug_description
24+
attributes:
25+
label: Describe the bug
26+
description: A clear and concise description of what the bug is.
27+
placeholder: Enter the bug details here
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: steps_to_reproduce
33+
attributes:
34+
label: Steps to reproduce
35+
description: Describe the steps to reproduce the behavior.
36+
placeholder: "1. ...\n2. ...\n3. ..."
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: expected_behavior
42+
attributes:
43+
label: Expected behavior
44+
description: A clear and concise description of what you expected to happen.
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: additional_context
50+
attributes:
51+
label: Additional context
52+
description: Add any other context or screenshots about the problem.
53+
54+
- type: input
55+
id: version
56+
attributes:
57+
label: QueryLink version
58+
description: With which QueryLink NuGet version are you experiencing the issue?
59+
placeholder: QueryLink version number
60+
validations:
61+
required: true
62+
63+
- type: input
64+
id: dotnet-version
65+
attributes:
66+
label: .NET version
67+
description: With which .NET version are you experiencing the issue?
68+
placeholder: .NET version
69+
validations:
70+
required: true
71+
72+
- type: dropdown
73+
id: environment
74+
attributes:
75+
label: Environment
76+
description: Provide details about the environment where the issue occurs.
77+
multiple: true
78+
options:
79+
- Windows
80+
- macOS
81+
- Linux
82+
- Other
83+
validations:
84+
required: true
85+
86+
- type: checkboxes
87+
id: will-patch
88+
attributes:
89+
label: Contribute a patch?
90+
description: |
91+
If you plan to contribute a patch for this issue yourself, please check the box below - to tell us and others looking at the issue that someone’s already working on it. If you do check this box, please try to send a pull request within 7 days or so.
92+
options:
93+
- label: I’ll contribute a patch for this myself.
94+
95+
- type: checkboxes
96+
id: terms
97+
attributes:
98+
label: Code of Conduct
99+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/ByteAether/QueryLink/blob/main/CODE_OF_CONDUCT.md).
100+
options:
101+
- label: I agree to follow this project's Code of Conduct
102+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: "🚀 Feature Request"
2+
description: "Suggest a new feature or improvement to the project."
3+
title: "[Feature Request]: "
4+
labels:
5+
- enhancement
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for suggesting a feature! Please provide as much detail as possible.
11+
12+
- type: checkboxes
13+
id: preconditions
14+
attributes:
15+
label: Things to check
16+
options:
17+
- label: I have searched the **existing issues** for this bug
18+
required: true
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: feature_description
24+
attributes:
25+
label: Describe the feature
26+
description: A clear and concise description of what you want to happen.
27+
placeholder: Enter the feature details here
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: problem_to_solve
33+
attributes:
34+
label: Problem to solve
35+
description: Describe the problem your feature will address.
36+
placeholder: Enter the problem details here
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: examples
42+
attributes:
43+
label: Have you seen this feature anywhere else?
44+
description: Please provide links to other implementations, or screenshots or videos of the expected behavior if possible.
45+
placeholder: Show us examples!
46+
47+
- type: textarea
48+
id: alternatives
49+
attributes:
50+
label: Alternatives considered
51+
description: Describe any alternative solutions or features you’ve considered.
52+
53+
- type: textarea
54+
id: additional_context
55+
attributes:
56+
label: Additional context
57+
description: Add any other context or screenshots to explain your feature request.
58+
59+
- type: checkboxes
60+
id: will-patch
61+
attributes:
62+
label: Contribute a patch?
63+
description: |
64+
If you plan to contribute a patch for this issue yourself, please check the box below - to tell us and others looking at the issue that someone’s already working on it. If you do check this box, please try to send a pull request within 7 days or so.
65+
options:
66+
- label: I’ll contribute a patch for this myself.
67+
68+
- type: checkboxes
69+
id: terms
70+
attributes:
71+
label: Code of Conduct
72+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/ByteAether/QueryLink/blob/main/CODE_OF_CONDUCT.md).
73+
options:
74+
- label: I agree to follow this project's Code of Conduct
75+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<!-- Provide a general summary of your changes in the Title above -->
2+
<!-- Keep the title short and descriptive, as it will be used as a commit message -->
3+
4+
## Description
5+
<!-- Provide a detailed description of your changes and explain why they are needed. -->
6+
7+
## Related Issues
8+
<!-- List any related issues by number (e.g., "Fixes #123", "Closes #456"). -->
9+
10+
- Fixes #
11+
- Closes #
12+
- Related to #
13+
14+
## Type of Change
15+
<!-- Check all that apply and provide more details if needed. Put an `x` in only one box that applies best: -->
16+
17+
- [ ] Bug fix (non-breaking change that fixes an issue)
18+
- [ ] New feature (non-breaking change that adds functionality)
19+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
20+
- [ ] Documentation update
21+
- [ ] Other (please specify):
22+
23+
## Checklist
24+
<!-- Ensure the following tasks are completed before submission. -->
25+
<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
26+
27+
- [ ] The PR is submitted to the correct branch (`main`).
28+
- [ ] My code follows the project's coding style. (`.editorconfig`)
29+
- [ ] I have commented my code, particularly in hard-to-understand areas and public interfaces.
30+
- [ ] I have added or updated tests for the changes I made.
31+
- [ ] All new and existing tests passed.
32+
- [ ] I have updated the documentation where applicable.
33+
34+
## Testing Instructions
35+
<!-- Explain how the changes were tested and how reviewers can verify them. -->
36+
37+
1. Step 1
38+
2. Step 2
39+
3. Step 3
40+
41+
## Screenshots (if applicable)
42+
43+
## Additional Notes
44+
<!-- Add any other relevant context, considerations, or important details. -->

‎.github/workflows/codeql.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: "CodeQL Advanced"
2+
3+
on:
4+
push:
5+
branches: [ "main" ]
6+
paths:
7+
- src/**
8+
pull_request:
9+
branches: [ "main" ]
10+
paths:
11+
- src/**
12+
schedule:
13+
- cron: '20 6 * * 5'
14+
workflow_dispatch:
15+
16+
jobs:
17+
analyze:
18+
name: Analyze
19+
runs-on: ubuntu-latest
20+
21+
permissions:
22+
actions: read # Allow GitHub Actions to read workflow files
23+
contents: read # Allow access to repository contents
24+
security-events: write # Allow writing security alerts to the Security tab
25+
26+
strategy:
27+
fail-fast: false
28+
matrix:
29+
language: [ 'csharp' ] # Specify the language(s) to analyze
30+
31+
steps:
32+
- name: Checkout repository
33+
uses: actions/checkout@v4
34+
35+
- name: Setup .NET
36+
uses: actions/setup-dotnet@v4
37+
with:
38+
dotnet-version: |
39+
8.x
40+
6.x
41+
42+
- name: Initialize CodeQL
43+
uses: github/codeql-action/init@v3
44+
with:
45+
languages: ${{ matrix.language }}
46+
config-file: ./.github/workflows/codeql/codeql-config.yml
47+
48+
- name: Build the code
49+
run: |
50+
# Restore dependencies and build the C# project
51+
dotnet restore src/ByteAether.QueryLink/ByteAether.QueryLink.csproj
52+
dotnet build --no-incremental --configuration Release src/ByteAether.QueryLink/ByteAether.QueryLink.csproj
53+
54+
- name: Perform CodeQL Analysis
55+
uses: github/codeql-action/analyze@v3
56+
with:
57+
category: "/language:${{matrix.language}}"

‎.github/workflows/codeql/codeql-config.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: "Security and Quality"
2+
3+
queries:
4+
- uses: security-and-quality
5+
6+
query-filters:
7+
- exclude:
8+
id: cs/useless-if-statement
9+
- exclude:
10+
id: cs/empty-block
11+
- exclude:
12+
id: cs/useless-assignment-to-local

‎CODE_OF_CONDUCT.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
The ByteAether's software code of conduct is derived from [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct/).
2+
3+
- Participants will be tolerant of opposing views.
4+
- Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
5+
- When interpreting the words and actions of others, participants should always assume good intentions.
6+
- Behavior that can be reasonably considered harassment will not be tolerated.

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2024 ByteAether, Joonatan Uusv�li
3+
Copyright (c) 2024-2025 ByteAether, Joonatan Uusv�li
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -296,11 +296,16 @@ The full functionality of LINQ is still available. You are free to write any `.W
296296

297297
### I need projections; the raw data models are not enough for me.
298298

299-
You can use any library that can map objects from one to another. Our library does not limit you in any way and will work with the dataset you provide in the form of `IQueryable<T>`, whatever the `T` may be.
299+
You can use any library that can map objects from one to another or use your own mapper code. Our library does not limit you in any way and will work with the dataset you provide in the form of `IQueryable<T>`, whatever the `T` may be.
300300

301301
## Contributing
302302

303-
Contributions are welcome! Please open an issue or submit a pull request if you have any suggestions or improvements.
303+
We welcome all contributions! You can:
304+
305+
* **Open a Pull Request:** Fork the repository, create a branch, make your changes, and submit a pull request to the `main` branch.
306+
* **Report Issues:** Found a bug or have a suggestion? [Open an issue](https://github.com/ByteAether/Ulid/issues) with details.
307+
308+
Thank you for helping improve the project!
304309

305310
## License
306311

‎src/ByteAether.QueryLink/ByteAether.QueryLink.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<PropertyGroup>
44
<TargetFrameworks>net8.0;net6.0;netstandard2.1</TargetFrameworks>
5-
<LangVersion>12.0</LangVersion>
5+
<LangVersion>latest</LangVersion>
66
<OutputType>Library</OutputType>
77
<ImplicitUsings>enable</ImplicitUsings>
88
<Nullable>enable</Nullable>

0 commit comments

Comments
 (0)