Skip to content

Commit cd5406e

Browse files
esthersoftwaredevesthersoftwaredev
committed
template and docs
1 parent 55f55fc commit cd5406e

File tree

8 files changed

+332
-1
lines changed

8 files changed

+332
-1
lines changed

‎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 at
63+
[email protected].
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.

‎CONTRIBUTING.md

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Contributing to TechOpenSolve
2+
3+
Thank you for your interest in contributing to TechOpenSolve! We welcome contributions from individuals, companies, and organizations passionate about driving positive change within the tech industry. By working together, we can address real-life challenges and create a more inclusive, supportive, and innovative environment for all.
4+
5+
## How to Contribute
6+
7+
### 1. Identify an Issue
8+
9+
Start by exploring the repository to identify issues that resonate with you. Issues represent real-life challenges faced by individuals in the tech industry. If the issue exists you can move on to step [4](#4-contributing). If the issue does not exist continue with steps 2 and 3.
10+
11+
### 2. Open a Discussion
12+
13+
If you don't find an existing issue that addresses a particular challenge, open a [Discussion of type Idea](https://github.com/orgs/TechOpenSolve/discussions) to suggest it. Engage with the community to gather feedback and refine the scope of the issue.
14+
15+
### 3. Document the Issue
16+
17+
Once an issue is accepted, document it with clear descriptions and relevant details. Be sure to provide context and examples to help others understand the problem.
18+
19+
### 4. Contributing
20+
21+
Choose one of the following options to contribute:
22+
23+
#### Option 1: Recognize Contributions
24+
25+
Recognize existing contributions made by others:
26+
27+
To acknowledge and give credit to individuals, companies, or organizations that have positively contributed with helpful actions that aid the process of addressing an issue, follow these steps:
28+
29+
1. Navigate to the relevant issue where the contribution occurred.
30+
2. Add a comment below the issue acknowledging the contribution and providing details and links using the following template:
31+
32+
```
33+
#### Contribution Acknowledgement:
34+
35+
- **Contributor:** [Name/Username]
36+
- **Contribution:** [Brief description of the action they took]
37+
- **How does it help:**
38+
[Provide details about how this contribution makes a positive impact]
39+
- **Link:**
40+
[Provide a link (blog post, video, company page, user profile) - most suitable link ]
41+
42+
Thank you, [Name/Username], and [any other individuals/companies/organizations involved],
43+
for your valuable contribution.
44+
This marks a significant step in our efforts towards resolving the issue!!
45+
46+
```
47+
Replace the placeholders (e.g., [Name/Username], [Description of the contribution], [Link], [Additional Details]) with the appropriate information.
48+
49+
3. Ensure that the comment provides clear and detailed recognition of the contribution, including any relevant links or resources.
50+
51+
#### Option 2: Make a Contribution
52+
53+
1. Contribute yourself by adding meaningful impact within real-life scenarios. Here are just a few possible suggestions, to help you get started:
54+
55+
- Implementing practical solutions in real-life scenarios.
56+
- Providing jobs, support, guidance, or resources to individuals or groups affected by the issue.
57+
- Writing blog posts, creating videos, or other ways of advocating for change within organizations or communities.
58+
- Collaborating with others to brainstorm and implement innovative approaches that bring a positive impact.
59+
60+
Of course there are many more options for making contributions. Feel free to explore other ways to contribute and make a difference in addressing real-life challenges within the tech industry.
61+
62+
2. After completing your real life contribution use the
63+
[Contribution Acknowledgement Template](#option-1-recognize-contributions) to document your contribution by leaving a comment.
64+
65+
### 5. Fact Checking
66+
67+
Contributions will undergo fact checking and upon determining authenticity and if they are significant then they can move on to the next stage.
68+
69+
### 6. Pull Requests
70+
71+
- Pull requests will be made only in the [**app**](https://github.com/TechOpenSolve/app) repo - this is the live version of our website.
72+
- Pull requests will not be marking an issue as resolved.
73+
- Each pull request will contain a commit featuring the contribution that has been left as a comment and went through fact checking.
74+
- Pull Request will be matched to the appropriate category and upon successful merge will be visualized on the website.
75+
76+
The app repo has it's own CONTRIBUTING.md document so make sure you check it out before creating a Pull Request.
77+
78+
79+
80+
81+

‎FUNDING.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# These are supported funding model platforms
2+
3+
github: [monacodelisa]

‎ISSUE_TEMPLATE/bug_report.yml

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: 🐛 Bug report
2+
description: Create a bug report to help TechOpenSolve's mission
3+
title: "Tech Community Issue: "
4+
labels: [👀 needs triage, 🐛 bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
- type: textarea
11+
attributes:
12+
label: Describe the bug
13+
description: A clear and concise description of what the bug is.
14+
validations:
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: Describe the real life issue
19+
description: Provide details.
20+
placeholder: |
21+
1. What is the issue?
22+
2. Is is a single or recurring issue?
23+
3. How long has it been happening for?
24+
4. Has anyone involved taken actions to resolve it?
25+
5. How many people have been affected?
26+
6. Other details
27+
validations:
28+
required: true
29+
- type: dropdown
30+
attributes:
31+
multiple: true
32+
label: Who has faced this issue?
33+
description: Select whether you or someone else has faced this issue.
34+
options:
35+
- "Me"
36+
- "Someone else"
37+
- "Both"
38+
- "Group of people"
39+
- "Other (add additional context)"
40+
- type: checkboxes
41+
id: assistance
42+
attributes:
43+
label: I have read the CONTRIBUTING.md file
44+
description: Assistance is provided if you need help
45+
options:
46+
- label: "Yes"
47+
- label: 'No'

‎ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: ❓ Ask a question
4+
url: https://discord.gg/VcEFsQad
5+
about: Ask questions about open source onboarding

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Esther White
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

+26-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,26 @@
1-
# Community
1+
# Welcome to the Community Repo
2+
3+
This repository focuses on issues that can be improved within the tech community.
4+
5+
## What is the Tech Community?
6+
7+
The tech community is a vibrant and diverse network of individuals, organizations, and enthusiasts who come together to collaborate, innovate, and advance the field of technology. It encompasses software developers, engineers, designers, entrepreneurs, educators, advocates, and more, all united by their passion for technology and their desire to make a positive impact.
8+
9+
## What Issues could be addressed within this Repository
10+
11+
The TechOpenSolve Community Repository serves as a platform for documenting, discussing, and collaborating on issues that affect various aspects of the tech community, here are some examples:
12+
13+
- **Recognition Challenges**: Issues related to determining how to provide recognition for contributions within the tech community. This includes recognizing individuals, projects, achievements, and initiatives that deserve acknowledgment.
14+
15+
- **Fostering Interactions**: Issues concerning communication, collaboration, and engagement within the tech community. This includes improving interactions among community members, facilitating knowledge sharing, and promoting inclusion.
16+
17+
- **Community Events**: Issues related to organizing, participating in, or improving community events such as conferences, meetups, workshops, and hackathons. This involves planning and executing events that bring together members of the tech community.
18+
19+
There are many more topics within the tech community that deserve attention, but these are just a few examples of the issue types we aim to include in this repo.
20+
21+
## Get Involved
22+
We invite individuals, companies, organizations, and communities passionate about improving the tech community to join us in our mission. Whether you're a developer, a tech enthusiast, an advocate for diversity and inclusion, or anyone else interested in making a meaningful impact, your contributions are valued and appreciated.
23+
24+
Start by reading the [CONTRIBUTING.md](CONTRIBUTING.md) to learn how you can get involved and contribute to addressing real-life challenges within the tech community.
25+
26+
Let's work together to address real-life challenges, drive positive change, and create a more inclusive and supportive tech community for all.

‎SECURITY.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Use this section to tell people about which versions of your project are
6+
currently being supported with security updates.
7+
8+
| Version | Supported |
9+
| ------- | ------------------ |
10+
| 5.1.x | :white_check_mark: |
11+
| 5.0.x | :x: |
12+
| 4.0.x | :white_check_mark: |
13+
| < 4.0 | :x: |
14+
15+
## Reporting a Vulnerability
16+
17+
Use this section to tell people how to report a vulnerability.
18+
19+
Tell them where to go, how often they can expect to get an update on a
20+
reported vulnerability, what to expect if the vulnerability is accepted or
21+
declined, etc.

0 commit comments

Comments
 (0)