Skip to content

Commit 9818319

Browse files
Syntax-Error-1337Syntax-Error-1337
committed
chore: add community health files and dev configuration
- Added LICENSE, CODE_OF_CONDUCT, CONTRIBUTING, and SECURITY files - Added GitHub issue and PR templates - Added Codespaces and VS Code configuration - Updated README with badges and contributing section
1 parent 417b405 commit 9818319

11 files changed

Lines changed: 319 additions & 1 deletion

File tree

‎.devcontainer/devcontainer.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"name": "Open-Temp-Mail Dev Container",
3+
"image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bullseye",
4+
"customizations": {
5+
"vscode": {
6+
"extensions": [
7+
"esbenp.prettier-vscode",
8+
"dbaeumer.vscode-eslint",
9+
"bradlc.vscode-tailwindcss"
10+
]
11+
}
12+
},
13+
"forwardPorts": [
14+
5173,
15+
8787
16+
],
17+
"postCreateCommand": "npm install"
18+
}

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '...'
17+
3. Scroll down to '...'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Description
2+
3+
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.
4+
5+
Fixes # (issue)
6+
7+
## Type of change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] Documentation update
15+
16+
## How Has This Been Verified?
17+
18+
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
19+
20+
- [ ] Test A
21+
- [ ] Test B
22+
23+
## Checklist:
24+
25+
- [ ] My code follows the style guidelines of this project
26+
- [ ] I have performed a self-review of my own code
27+
- [ ] I have commented my code, particularly in hard-to-understand areas
28+
- [ ] I have made corresponding changes to the documentation
29+
- [ ] My changes generate no new warnings
30+
- [ ] I have added tests that prove my fix is effective or that my feature works
31+
- [ ] New and existing unit tests pass locally with my changes

‎.vscode/extensions.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"recommendations": [
3+
"esbenp.prettier-vscode",
4+
"dbaeumer.vscode-eslint",
5+
"bradlc.vscode-tailwindcss"
6+
]
7+
}

‎.vscode/settings.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"editor.formatOnSave": true,
3+
"editor.defaultFormatter": "esbenp.prettier-vscode",
4+
"editor.codeActionsOnSave": {
5+
"source.fixAll.eslint": "explicit"
6+
},
7+
"files.exclude": {
8+
"**/.git": true,
9+
"**/.DS_Store": true,
10+
"**/node_modules": true
11+
}
12+
}

‎CODE_OF_CONDUCT.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
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, caste, color, religion, or sexual
10+
identity 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+
## Scope
47+
48+
This Code of Conduct applies within all community spaces, and also applies when
49+
an individual is officially representing the community in public spaces.
50+
Examples of representing our community include using an official e-mail address,
51+
posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event.
53+
54+
## Enforcement
55+
56+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
57+
reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD].
58+
All complaints will be reviewed and investigated promptly and fairly.
59+
60+
All community leaders are obligated to respect the privacy and security of the
61+
reporter of any incident.
62+
63+
## Attribution
64+
65+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
66+
version 2.1, available at
67+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
68+
69+
[homepage]: https://www.contributor-covenant.org
70+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

‎CONTRIBUTING.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributing to Open-Temp-Mail
2+
3+
First off, thanks for taking the time to contribute! ❤️
4+
5+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.
6+
7+
## Table of Contents
8+
9+
- [Code of Conduct](#code-of-conduct)
10+
- [I Have a Question](#i-have-a-question)
11+
- [I Want To Contribute](#i-want-to-contribute)
12+
- [Reporting Bugs](#reporting-bugs)
13+
- [Suggesting Enhancements](#suggesting-enhancements)
14+
- [Your First Code Contribution](#your-first-code-contribution)
15+
16+
## Code of Conduct
17+
18+
This project and everyone participating in it is governed by the
19+
[Open-Temp-Mail Code of Conduct](CODE_OF_CONDUCT.md).
20+
By participating, you are expected to uphold this code. Please report unacceptable behavior to [INSERT CONTACT METHOD].
21+
22+
## I Have a Question
23+
24+
If you want to ask a question, we assume that you have read the available [Documentation](README.md).
25+
26+
## I Want To Contribute
27+
28+
### Reporting Bugs
29+
30+
This section guides you through submitting a bug report for Open-Temp-Mail. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
31+
32+
- **Use a clear and descriptive title** for the issue to identify the problem.
33+
- **Describe the exact steps to reproduce the problem** in as many details as possible.
34+
- **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
35+
36+
### Suggesting Enhancements
37+
38+
This section guides you through submitting an enhancement suggestion for Open-Temp-Mail, including completely new features and minor improvements to existing functionality.
39+
40+
- **Use a clear and descriptive title** for the issue to identify the suggestion.
41+
- **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
42+
- **Provide specific examples to demonstrate the steps**.
43+
44+
### Your First Code Contribution
45+
46+
1. **Fork the repository** on GitHub.
47+
2. **Clone your fork** locally.
48+
```bash
49+
git clone https://github.com/your-username/open-temp-mail.git
50+
cd open-temp-mail
51+
```
52+
3. **Create a new branch** for your feature or fix.
53+
```bash
54+
git checkout -b feature/my-new-feature
55+
```
56+
4. **Make your changes** and commit them.
57+
```bash
58+
git commit -m "Add some feature"
59+
```
60+
5. **Push to your fork**.
61+
```bash
62+
git push origin feature/my-new-feature
63+
```
64+
6. **Open a Pull Request** on GitHub.
65+
66+
## Styleguides
67+
68+
### Commit Messages
69+
70+
- Use the present tense ("Add feature" not "Added feature")
71+
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
72+
- Limit the first line to 72 characters or less
73+
- Reference issues and pull requests liberally after the first line

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Open-Temp-Mail Contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# 📬 Open-Temp-Mail
22

3-
[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/Syntax-Error-1337/open-temp-mail)
3+
[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/deploy-button.svg)](https://deploy.workers.cloudflare.com/?url=https://github.com/Syntax-Error-1337/Open-Temp-Mail)
4+
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/Syntax-Error-1337/Open-Temp-Mail)
45
![License](https://img.shields.io/badge/license-MIT-blue.svg)
56
![Version](https://img.shields.io/badge/version-1.0.0-green.svg)
67
![Status](https://img.shields.io/badge/status-stable-success.svg)
@@ -57,6 +58,14 @@
5758
```
5859
Visit `http://localhost:5173` to view the app.
5960

61+
## 🤝 Contributing
62+
63+
We love contributions! Please read our [Contributing Guide](CONTRIBUTING.md) to get started.
64+
65+
- report bugs using our [Bug Report Template](.github/ISSUE_TEMPLATE/bug_report.md)
66+
- suggest features using our [Feature Request Template](.github/ISSUE_TEMPLATE/feature_request.md)
67+
- please respect our [Code of Conduct](CODE_OF_CONDUCT.md)
68+
6069
## ⚙️ Configuration
6170

6271
Open-Temp-Mail uses `wrangler.toml` for configuration.

0 commit comments

Comments
 (0)