Skip to content

Commit 9dc73a1

Browse files
JusterZhuclaude
andcommitted
chore: add .NET Foundation prerequisite files
- CODE_OF_CONDUCT.md (Contributor Covenant v2.1) - SECURITY.md (vulnerability reporting policy) - CONTRIBUTING.md (contribution guidelines) - Directory.Build.props (SourceLink, embedded PDBs, deterministic builds) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 76168ed commit 9dc73a1

4 files changed

Lines changed: 225 additions & 0 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
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 at
63+
zhuzhen723723@outlook.com.
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.1, available at
119+
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
https://www.contributor-covenant.org/faq. Translations are available at
126+
https://www.contributor-covenant.org/translations.
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[Mozilla CoC]: https://github.com/mozilla/inclusion

CONTRIBUTING.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributing to GeneralUpdate
2+
3+
Thank you for your interest in contributing to GeneralUpdate! We welcome contributions from the community.
4+
5+
## How to Contribute
6+
7+
### Reporting Issues
8+
9+
- Use the GitHub Issues tab to report bugs or suggest features.
10+
- Check if a similar issue already exists before creating a new one.
11+
- Provide as much detail as possible: steps to reproduce, environment info, screenshots if applicable.
12+
13+
### Submitting Changes
14+
15+
1. **Fork** the repository.
16+
2. **Create a feature branch** from `main`:
17+
```
18+
git checkout -b feat/your-feature-name
19+
```
20+
3. **Make your changes**, following the coding style of the existing codebase.
21+
4. **Write or update tests** to cover your changes.
22+
5. **Ensure all tests pass** by running the test suite.
23+
6. **Commit your changes** with a clear commit message:
24+
```
25+
feat: add support for xxx
26+
fix: resolve issue with xxx
27+
docs: update readme for xxx
28+
```
29+
7. **Push to your fork** and submit a Pull Request.
30+
8. In your PR description, explain what the change does and why it is needed.
31+
32+
### Pull Request Guidelines
33+
34+
- Keep PRs focused on a single concern. If you have multiple unrelated changes, submit separate PRs.
35+
- Ensure your code builds cleanly and passes all tests.
36+
- Update documentation if your change affects public APIs or usage.
37+
- Be responsive to review feedback. We aim to review PRs within one week.
38+
39+
## Code Style
40+
41+
- Follow the existing coding conventions used in the project.
42+
- Use consistent indentation (spaces, 4 per level).
43+
- Add XML documentation comments for public APIs.
44+
- Run `dotnet format` before committing if possible.
45+
46+
## Questions?
47+
48+
If you have questions, feel free to open a Discussion on GitHub or reach out via Discord (server link available on the project website).
49+
50+
Thank you for contributing!

SECURITY.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you discover a security vulnerability in GeneralUpdate, please report it by emailing the project lead at **zhuzhen723723@outlook.com**.
6+
7+
Please **do not** create a public GitHub issue for security vulnerabilities.
8+
9+
We will acknowledge receipt of your report within 72 hours and provide an estimated timeline for a fix and release.
10+
11+
## Disclosure Policy
12+
13+
- We will investigate and validate the report within 7 business days.
14+
- A fix will be prepared and tested before any public disclosure.
15+
- A security advisory will be published on GitHub once the fix is released.
16+
- We will credit the reporter if they wish to be acknowledged.
17+
18+
## Supported Versions
19+
20+
| Version | Supported |
21+
| ------- | ------------------ |
22+
| Latest major release | ✅ Yes |
23+
| Older versions | ⚠️ Limited (critical fixes only) |

src/c#/Directory.Build.props

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<Project>
2+
<PropertyGroup>
3+
<!-- Source Link -->
4+
<PublishRepositoryUrl>true</PublishRepositoryUrl>
5+
<EmbedUntrackedSources>true</EmbedUntrackedSources>
6+
<IncludeSymbols>true</IncludeSymbols>
7+
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
8+
9+
<!-- Embedded PDBs -->
10+
<DebugType>embedded</DebugType>
11+
<DebugSymbols>true</DebugSymbols>
12+
13+
<!-- Deterministic / Reproducible builds -->
14+
<ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
15+
<Deterministic>true</Deterministic>
16+
<DeterministicSourcePaths>true</DeterministicSourcePaths>
17+
</PropertyGroup>
18+
19+
<!-- Source Link package (auto-detects GitHub) -->
20+
<ItemGroup>
21+
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All"/>
22+
</ItemGroup>
23+
</Project>

0 commit comments

Comments
 (0)