Skip to content

Commit 09597c4

Browse files
committed
copied the files from templateRepo and adapted to SDLC_core Repo requirements
copied the files from templateRepo and adapted to SDLC_core Repo requirements
1 parent 7509751 commit 09597c4

File tree

281 files changed

+24380
-218
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

281 files changed

+24380
-218
lines changed

.editorconfig

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
trim_trailing_whitespace = true
6+
insert_final_newline = true
7+
8+
[{*.cpp,*.c,*.hpp,*.h,*.cs}]
9+
indent_style = space
10+
indent_size = 4
11+
12+
[*.json]
13+
indent_style = space
14+
indent_size = 2

.gitattributes

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
###############################################################################
2+
# Set default behavior to automatically normalize line endings.
3+
###############################################################################
4+
#* -text
5+
6+
#*.inc linguist-language=cpp
7+
8+
###############################################################################
9+
# Set default behavior for command prompt diff.
10+
#
11+
# This is need for earlier builds of msysgit that does not have it on by
12+
# default for csharp files.
13+
# Note: This is only used by command line
14+
###############################################################################
15+
#*.cs diff=csharp
16+
17+
###############################################################################
18+
# Set the merge driver for project and solution files
19+
#
20+
# Merging from the command prompt will add diff markers to the files if there
21+
# are conflicts (Merging from VS is not affected by the settings below, in VS
22+
# the diff markers are never inserted). Diff markers may cause the following
23+
# file extensions to fail to load in VS. An alternative would be to treat
24+
# these files as binary and thus will always conflict and require user
25+
# intervention with every merge. To do so, just uncomment the entries below
26+
###############################################################################
27+
#*.sln merge=binary
28+
#*.csproj merge=binary
29+
#*.vbproj merge=binary
30+
#*.vcxproj merge=binary
31+
#*.vcproj merge=binary
32+
#*.dbproj merge=binary
33+
#*.fsproj merge=binary
34+
#*.lsproj merge=binary
35+
#*.wixproj merge=binary
36+
#*.modelproj merge=binary
37+
#*.sqlproj merge=binary
38+
#*.wwaproj merge=binary
39+
40+
###############################################################################
41+
# behavior for image files
42+
#
43+
# image files are treated as binary by default.
44+
###############################################################################
45+
#*.jpg binary
46+
#*.png binary
47+
#*.gif binary
48+
49+
###############################################################################
50+
# diff behavior for common document formats
51+
#
52+
# Convert binary document formats to text before diffing them. This feature
53+
# is only available from the command line. Turn it on by uncommenting the
54+
# entries below.
55+
###############################################################################
56+
#*.doc diff=astextplain
57+
#*.DOC diff=astextplain
58+
#*.docx diff=astextplain
59+
#*.DOCX diff=astextplain
60+
#*.dot diff=astextplain
61+
#*.DOT diff=astextplain
62+
#*.pdf diff=astextplain
63+
#*.PDF diff=astextplain
64+
#*.rtf diff=astextplain
65+
#*.RTF diff=astextplain
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: "Bug report 🐛"
2+
description: Report errors or unexpected behavior
3+
labels: [Issue-Bug, Needs-Triage]
4+
type: Bug
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please make sure to [search for existing issues](https://github.com/SoftwareDevLabs/SDLC_core/issues) and [check the FAQ](https://github.com/SoftwareDevLabs/SDLC_core/wiki/Frequently-Asked-Questions-(FAQ)) before filing a new one!
10+
11+
If this is an application crash, please also provide a [Feedback Hub](mailto:info@softwaredevlabs.com) submission link so we can find your diagnostic data on the backend.
12+
13+
- type: input
14+
attributes:
15+
label: SDLC_core Version
16+
placeholder: "1.21.2701.0"
17+
description: |
18+
Please provide the current version of the SDLC_core.
19+
validations:
20+
required: false
21+
22+
- type: input
23+
attributes:
24+
label: Overall toolchain build number
25+
placeholder: "10.0.22621.0"
26+
description: |
27+
Please provide the overall toolchain build number.
28+
validations:
29+
required: false
30+
31+
- type: textarea
32+
attributes:
33+
label: Other Software
34+
description: If you're reporting a bug about our interaction with other software, what software? What versions?
35+
placeholder: |
36+
vim 9.1 (inside WSL)
37+
OpenSSH_for_Windows_9.5p1
38+
My Cool Application v0.4 (include a code snippet if it would help!)
39+
validations:
40+
required: false
41+
42+
- type: textarea
43+
attributes:
44+
label: Steps to reproduce
45+
placeholder: Tell us the steps required to trigger your bug.
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
attributes:
51+
label: Expected Behavior
52+
description: If you want to include screenshots, paste them into the markdown editor below.
53+
placeholder: What were you expecting?
54+
validations:
55+
required: false
56+
57+
- type: textarea
58+
attributes:
59+
label: Actual Behavior
60+
placeholder: What happened instead?
61+
validations:
62+
required: true
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: "Feature Request/Idea 🚀"
2+
description: Suggest a new feature or improvement (this does not mean you have to implement it)
3+
labels: [Issue-Feature]
4+
type: Feature
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Description of the new feature
9+
description: A clear and concise description of what the problem is that the new feature would solve.
10+
placeholder: |
11+
... and guess what? I have four Terminals. And I have a hover car, and a hover house. And my computer's a runner, and it shows.
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
attributes:
17+
label: Proposed technical implementation details
18+
description: This field is optional. If you have any ideas, let us know!
19+
validations:
20+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
## Summary of the Pull Request
2+
3+
## References and Relevant Issues
4+
5+
## Detailed Description of the Pull Request / Additional comments
6+
7+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
8+
9+
Fixes # (issue)
10+
11+
## Type of change
12+
13+
Please delete options that are not relevant.
14+
15+
- [ ] Bug fix (non-breaking change which fixes an issue)
16+
- [ ] New feature (non-breaking change which adds functionality)
17+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
18+
- [ ] This change requires a documentation update
19+
20+
## Performance Impact
21+
22+
Please describe any relevant performance impact of this change. This can be positive or negative impact. How did you characterize/test the performance impact?
23+
24+
## How Has This Been Tested?
25+
26+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
27+
28+
- [ ] Test A
29+
- [ ] Test B
30+
31+
<!--**Hardware Configuration**:
32+
- [ ] Dev Board
33+
- [ ] Test rack
34+
- [ ] DVT Boards
35+
- [ ] Production Boards
36+
-->
37+
38+
**Software Configuration**:
39+
- [ ] Operating System:
40+
- [ ] Software version:
41+
- [ ] Branch:
42+
- [ ] Toolchain version:
43+
- [ ] SDK version:
44+
45+
## Validation Steps Performed
46+
47+
## PR Checklist:
48+
49+
- [ ] My code follows the style guidelines of this project
50+
- [ ] I have performed a self-review of my own code
51+
- [ ] I have commented my code, particularly in hard-to-understand areas
52+
- [ ] I have made corresponding changes to the documentation
53+
- [ ] My changes generate no new warnings
54+
- [ ] I have added tests that prove my fix is effective or that my feature works
55+
- [ ] New and existing unit tests pass locally with my changes
56+
- [ ] Any dependent changes have been merged and published in downstream modules
57+
- [ ] I have checked my code and corrected any misspellings
58+
- [ ] Closes #xxx
59+
- [ ] Tests added/passed
60+
- [ ] Documentation updated
61+
- If checked, please file a pull request on [our docs repo](https://github.com/SoftwareDevLabs) and link it here: #xxx
62+
- [ ] Schema updated (if necessary)

.github/actions/spelling/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# check-spelling/check-spelling configuration
2+
3+
File | Purpose | Format | Info
4+
-|-|-|-
5+
[allow/*.txt](allow/) | Add words to the dictionary | one word per line (only letters and `'`s allowed) | [allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow)
6+
[reject.txt](reject.txt) | Remove words from the dictionary (after allow) | grep pattern matching whole dictionary words | [reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-reject)
7+
[excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes)
8+
[patterns/*.txt](patterns/) | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
9+
[candidate.patterns](candidate.patterns) | Patterns that might be worth adding to [patterns.txt](patterns.txt) | perl regular expression with optional comment block introductions (all matches will be suggested) | [candidates](https://github.com/check-spelling/check-spelling/wiki/Feature:-Suggest-patterns)
10+
[line_forbidden.patterns](line_forbidden.patterns) | Patterns to flag in checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
11+
[expect/*.txt](expect.txt) | Expected words that aren't in the dictionary | one word per line (sorted, alphabetically) | [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect)
12+
[advice.md](advice.md) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice)
13+
14+
Note: you can replace any of these files with a directory by the same name (minus the suffix)
15+
and then include multiple files inside that directory (with that suffix) to merge multiple files together.

.github/actions/spelling/advice.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
2+
<details>
3+
<summary>
4+
:pencil2: Contributor please read this
5+
</summary>
6+
7+
By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.
8+
9+
If the listed items are:
10+
11+
* ... **misspelled**, then please *correct* them instead of using the command.
12+
* ... *names*, please add them to `.github/actions/spelling/allow/names.txt`.
13+
* ... APIs, you can add them to a file in `.github/actions/spelling/allow/`.
14+
* ... just things you're using, please add them to an appropriate file in `.github/actions/spelling/expect/`.
15+
* ... tokens you only need in one place and shouldn't *generally be used*, you can add an item in an appropriate file in `.github/actions/spelling/patterns/`.
16+
17+
See the `README.md` in each directory for more information.
18+
19+
:microscope: You can test your commits **without** *appending* to a PR by creating a new branch with that extra change and pushing it to your fork. The [check-spelling](https://github.com/marketplace/actions/check-spelling) action will run in response to your **push** -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. :wink:
20+
21+
22+
<details><summary>If the flagged items are :exploding_head: false positives</summary>
23+
24+
If items relate to a ...
25+
* binary file (or some other file you wouldn't want to check at all).
26+
27+
Please add a file path to the `excludes.txt` file matching the containing file.
28+
29+
File paths are Perl 5 Regular Expressions - you can [test](
30+
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
31+
32+
`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
33+
../tree/HEAD/README.md) (on whichever branch you're using).
34+
35+
* well-formed pattern.
36+
37+
If you can write a [pattern](
38+
https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns
39+
) that would match it,
40+
try adding it to the `patterns.txt` file.
41+
42+
Patterns are Perl 5 Regular Expressions - you can [test](
43+
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
44+
45+
Note that patterns can't match multiline strings.
46+
</details>
47+
48+
</details>
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Allow files are lists of words to accept unconditionally
2+
3+
While check spelling will complain about an expected word
4+
which is no longer present, you can include things here even if
5+
they are not otherwise present in the repository.
6+
7+
E.g., you could include a list of system APIs here, or potential
8+
contributors (so that if a future commit includes their name,
9+
it'll be accepted).
10+
11+
## Files
12+
13+
| File | Description |
14+
| ---- | ----------- |
15+
| [Allow](allow.txt) | Supplements to the dictionary |
16+
| [Chinese](chinese.txt) | Chinese words |
17+
| [Japanese](japanese.txt) | Japanese words |
18+
| [Microsoft](microsoft.txt) | Microsoft brand items |
19+
| [Fonts](fonts.txt) | Font names |
20+
| [Names](names.txt) | Names of people |
21+
| [Colors](colors.txt) | Names of color |

0 commit comments

Comments
 (0)