Skip to content

Commit

Permalink
feat: update images + add contributor guidelines (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
victorfrye authored Jan 24, 2024
1 parent 7a8a761 commit 6f44f71
Show file tree
Hide file tree
Showing 10 changed files with 505 additions and 36 deletions.
133 changes: 133 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@

# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[INSERT CONTACT METHOD].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
29 changes: 29 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<div align="center">
<img src="https://raw.githubusercontent.com/victorfrye/victorfrye/main/images/headstone.svg" alt="headstone" style="height: 64px; width: 64px; padding: 0 20px;"/>
<h1>Microsoft Graveyard</h1>
<p>The virtual graveyard for all products killed by Microsoft.</p>
</div>

## Contributing Guide

### Adding a product to the graveyard

The core list of dead products is maintained in the [corpses.json](/src/Client/wwwroot/data/corpses.json) file. This file is a JSON array of objects with the following a custom JSON schema. The schema is defined in the [corpses.schema.json](/files/corpses.schema.json) file but can be summarized as the following properties:

- `name` - The name of the product. This should NOT include Microsoft unless absolutely necessary as all products in this list are Microsoft products and could be prepended with the company's name.

- `subtitle` (OPTIONAL) - A short qualifier for the product. This will be rendered along with the name of the product and should be used to distinguish between products with the same name or a product/service/brand that is still alive. For example, the original Xbox console is dead but the Xbox brand is still alive. The subtitle for the original Xbox should be "original console" to distinguish it from the Xbox brand. This also can be used to highlight well known aliases or re-branded names for the product prefixed with the abbreviations "aka" or "fka".

- `description` - A short description of the product. This should be a single line without sentence casing and should not include the product's name. This will be automatically placed within a sentence by the application when rendered.

- `deathDate` - The date the product was killed. This should be in the format of `YYYY-MM-DD` and should be the date the product was officially killed by Microsoft or the end of life date indicated by Microsoft. If the product was killed multiple times, the most recent date should be used. If the product was significantly changed and re-branded, the date of the prior brand being killed should be used.

- `birthDate` - The date the product was born. This should be in the format of `YYYY-MM-DD` and should be the date the product was officially released by Microsoft. If the product was significantly changed and re-branded, the date of the current brand being released should be used.

- `link` - A link to an article or other source that confirms the product's death. This should be a permalink to the article and not a link to the site's homepage or Microsoft documentation if possible.

- `slug` - A unique slug for the product. This should be a lowercase, hyphenated version of the product's name. If the product's name is changed, the slug should be updated to match the new name.

## Code of Conduct

Microsoft Graveyard has adopted the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/), and we expect project participants to adhere to it. Please read [the full text](/.github/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
1 change: 1 addition & 0 deletions .github/workflows/azure-swa.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,5 @@ jobs:
uses: Azure/static-web-apps-deploy@v1
with:
azure_static_web_apps_api_token: ${{ secrets.AZURE_SWA_TOKEN }}
app_location: "src/Client"
action: "close"
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"dotnet.defaultSolution": "MicrosoftGraveyard.sln"
"dotnet.defaultSolution": "MicrosoftGraveyard.sln"
}
39 changes: 37 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,40 @@
# Microsoft Graveyard
<div align="center">
<img src="https://raw.githubusercontent.com/victorfrye/victorfrye/main/images/headstone.svg" alt="headstone" style="height: 64px; width: 64px; padding: 0 20px;"/>
<h1>Microsoft Graveyard</h1>
<p>The virtual graveyard for all products killed by Microsoft.</p>
</div>

The virtual graveyard for all products killed by Microsoft.
<div align="center">

[![GitHub issues](https://img.shields.io/github/issues/victorfrye/microsoftgraveyard)](https://github.com/victorfrye/microsoftgraveyard/issues)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](/.github/CODE_OF_CONDUCT.md)
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](/LICENSE)

</div>

## Technology Stack

<p align="left">
<a href="https://dotnet.microsoft.com/en-us/languages/csharp" target="_blank" rel="noreferrer" style="text-decoration: none;">
<img src="https://raw.githubusercontent.com/victorfrye/victorfrye/main/images/csharp.svg" width="36" height="36" alt="C#" />
</a>
<a href="https://dotnet.microsoft.com/en-us/" target="_blank" rel="noreferrer" style="text-decoration: none;">
<img src="https://raw.githubusercontent.com/victorfrye/victorfrye/main/images/dotnet.svg" width="36" height="36" alt=".NET" />
</a>
<a href="https://getbootstrap.com/" target="_blank" rel="noreferrer" style="text-decoration: none;">
<img src="https://raw.githubusercontent.com/victorfrye/victorfrye/main/images/bootstrap.svg" width="36" height="36" alt="Bootstrap" />
</a>
<a href="https://azure.microsoft.com/en-us/" target="_blank" rel="noreferrer" style="text-decoration: none;">
<img src="https://raw.githubusercontent.com/victorfrye/victorfrye/main/images/azure.svg" width="36" height="36" alt="Azure" />
</a>
</p>

Microsoft Graveyard is a static web application built utilizing .NET Blazor WASM and Bootstrap. The application is hosted on Azure as a Static Web App.

## Contributing

Contributions are welcome and key to maintaining this project! Please read the [contributing guide](/.github/CONTRIBUTING.md) below before submitting a pull request.

## Code of Conduct

Microsoft Graveyard has adopted the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/), and we expect project participants to adhere to it. Please read [the full text](/.github/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
Loading

0 comments on commit 6f44f71

Please sign in to comment.