Skip to content

Commit e88ea4a

Browse files
gregsdennisgregsdennis
committed
dotnet foundation repo updates
1 parent 6cd7984 commit e88ea4a

8 files changed

+2249
-1
lines changed

Diff for: ‎.editorconfig

+1,915
Large diffs are not rendered by default.

Diff for: ‎.gitattributes

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# Artfully "borrowed" from https://github.com/gitattributes/gitattributes
2+
3+
# Auto detect text files and perform LF normalization
4+
* text=auto
5+
6+
# C#
7+
*.cs text diff=csharp
8+
*.cshtml text diff=html
9+
*.csx text diff=csharp
10+
*.sln text eol=crlf
11+
*.csproj text eol=crlf
12+
13+
# Markdown
14+
*.md linguist-detectable
15+
16+
# Powershell
17+
*.ps1 text eol=crlf
18+
*.ps1x text eol=crlf
19+
*.psm1 text eol=crlf
20+
*.psd1 text eol=crlf
21+
*.ps1xml text eol=crlf
22+
*.pssc text eol=crlf
23+
*.psrc text eol=crlf
24+
*.cdxml text eol=crlf
25+
26+
# Documents
27+
*.bibtex text diff=bibtex
28+
*.doc diff=astextplain
29+
*.DOC diff=astextplain
30+
*.docx diff=astextplain
31+
*.DOCX diff=astextplain
32+
*.dot diff=astextplain
33+
*.DOT diff=astextplain
34+
*.pdf diff=astextplain
35+
*.PDF diff=astextplain
36+
*.rtf diff=astextplain
37+
*.RTF diff=astextplain
38+
*.md text diff=markdown
39+
*.mdx text diff=markdown
40+
*.tex text diff=tex
41+
*.adoc text
42+
*.textile text
43+
*.mustache text
44+
*.csv text eol=crlf
45+
*.tab text
46+
*.tsv text
47+
*.txt text
48+
*.sql text
49+
*.epub diff=astextplain
50+
51+
# Graphics
52+
*.png binary
53+
*.jpg binary
54+
*.jpeg binary
55+
*.gif binary
56+
*.tif binary
57+
*.tiff binary
58+
*.ico binary
59+
# SVG treated as text by default.
60+
*.svg text
61+
# If you want to treat it as binary,
62+
# use the following line instead.
63+
# *.svg binary
64+
*.eps binary
65+
66+
# Scripts
67+
*.bash text eol=lf
68+
*.fish text eol=lf
69+
*.ksh text eol=lf
70+
*.sh text eol=lf
71+
*.zsh text eol=lf
72+
# These are explicitly windows files and should use crlf
73+
*.bat text eol=crlf
74+
*.cmd text eol=crlf
75+
*.ps1 text eol=crlf
76+
77+
# Serialisation
78+
*.json text
79+
*.toml text
80+
*.xml text
81+
*.yaml text
82+
*.yml text
83+
84+
# Archives
85+
*.7z binary
86+
*.bz binary
87+
*.bz2 binary
88+
*.bzip2 binary
89+
*.gz binary
90+
*.lz binary
91+
*.lzma binary
92+
*.rar binary
93+
*.tar binary
94+
*.taz binary
95+
*.tbz binary
96+
*.tbz2 binary
97+
*.tgz binary
98+
*.tlz binary
99+
*.txz binary
100+
*.xz binary
101+
*.Z binary
102+
*.zip binary
103+
*.zst binary
104+
105+
# Text files where line endings should be preserved
106+
*.patch -text
107+
108+
#
109+
# Exclude files from exporting
110+
#
111+
112+
.gitattributes export-ignore
113+
.gitignore export-ignore
114+
.gitkeep export-ignore

Diff for: ‎.github/FUNDING.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# These are supported funding model platforms
2+
3+
github: gregsdennis
4+
patreon: gregsdennis
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: gregsdennis
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
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+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

Diff for: ‎.github/SECURITY.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Personal Information
2+
3+
Please don't share any personal information you don't want _everyone_ to know. Once it's on the internet, it's there forever.
4+
5+
Even editing personal information out of comments doesn't remove it, as comment history is available.
6+
7+
## Secure/Privileged Information
8+
9+
Please don't share any secure details, such as passwords or other keys.
10+
11+
Please don't share any proprietary information or code. If posting examples, create a [minimal reproducible example](https://en.wikipedia.org/wiki/Minimal_reproducible_example).
12+
13+
If for some reason secure information must be shared, please arrange to DM me (gregsdennis) in Slack (link in the README). I will not share any such information, and since the workspace is free, any messages will eventually be lost to the void.
14+
15+
## Security Reporting
16+
17+
Please share any security issues you find by DM'ing me in Slack. My best effort will be made to resolve these issues.

Diff for: ‎.github/SUPPORT.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
If you find you need help with any of the `json-everything` libraries you can:
2+
3+
- Join the [Slack workspace](https://join.slack.com/t/manateeopensource/shared_invite/enQtMzU4MjgzMjgyNzU3LWZjYzAzYzY3NjY1MjY3ODI0ZGJiZjc3Nzk1MDM5NTNlMjMyOTE0MzMxYWVjMjdiOGU1NDY5OGVhMGQ5YzY4Zjg),
4+
- Post a question on [StackOverflow](http://www.stackoverflow.com) with the `json-everything` tag\*
5+
6+
For feature requests, bug reports, or documentation errata reports, please create an issue.

Diff for: ‎CODE_OF_CONDUCT.md

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement
63+
via Slack (link in the README).
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

Diff for: ‎CONTRIBUTING.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Community Engagement
2+
3+
Questions, suggestions, corrections. All are welcome.
4+
5+
Channels for community engagement (where I'll be looking) include:
6+
7+
- Issues
8+
- Slack (link in the README)
9+
- StackOverflow (tag with `json-everything`)
10+
11+
# Lesson Authorship
12+
13+
The lessons are stored in several JSON files located in the `/LearnJsonEverything/wwwroot/data/lessons` folder. Each page on the site has its own file.
14+
15+
There is also an editor app for authoring lessons that is built with WPF, so it only runs on Windows. When using the app, you'll need to validate the lesson before saving by clicking the "Validate" button.
16+
17+
The unit tests run and validate all of the lessons and are run as part of the build.
18+
19+
# Development
20+
21+
## Requirements
22+
23+
This is a Blazor WASM site running on .Net 8, so you'll need those.
24+
25+
All of the projects are configured to use the latest C# version.
26+
27+
## IDE
28+
29+
I use Visual Studio Community with Resharper, and I try to keep everything updated.
30+
31+
Jetbrains Rider (comes with the Resharper stuff built-in), VS Code with your favorite extensions, or any basic text editor and a command line would work just fine. You do you.
32+
33+
## Command Line
34+
35+
The site and editor app can be run through Visual Studio (or probably through whatever IDE you're using).
36+
37+
Alternatively, you can run them using the `run` script file in the repository root.
38+
39+
- `run` on its own will run the site.
40+
- `run edit` will run the editor.
41+
42+
## Code Style & Releases
43+
44+
While I do have an `.editorconfig` that most editors should respect, please feel free to add any code contributions using your own coding style. Trying to conform to someone else's style can be a headache and confusing, and I prefer working code over pretty code. I find it's easier for contributors if I make my own style adjustments after a contribution rather than forcing conformance to my preferences.
45+
46+
Deployments to [learn.json-everything.net](https://learn.json-everything.net) occur automatically upon merging with `master`.
47+
48+
## Submitting PRs
49+
50+
Please be sure that an issue has been opened to allow for proper discussion before submitting a PR. If the project maintainers decide _not_ to merge your PR, you might feel you've wasted your time, and no one wants that.
51+
52+
## What Needs Doing?
53+
54+
Anything in the [issues](https://github.com/json-everything/json-everything-learn/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) with a `help wanted` label is something that could benefit from a volunteer or two.
55+
56+
Outside of this, PRs are welcome. For larger changes, it's preferred that there be some discussion in an issue before a PR is submitted. Mainly, I don't want you to feel like you've wasted your time if changes are requested or the PR is ultimately closed unmerged.

Diff for: ‎LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2024 Greg Dennis
3+
Copyright (c) .NET Foundation and Contributors
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

0 commit comments

Comments
 (0)