Skip to content

Commit 34a33e6

Browse files
docs update
1 parent 085ffb3 commit 34a33e6

File tree

4 files changed

+31
-30
lines changed

4 files changed

+31
-30
lines changed

.vscode/settings.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"cSpell.words": [
3+
"asknolagments"
4+
]
5+
}

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Contributions towards resolving an issue can take various forms, including:
4949

5050
## Recognizing Contributions
5151

52-
Every individual, company, or organization that contributes positively toward resolving an issue is acknowledged and given credit for their efforts. Larger contributions will be featured on the TechOpenSolve website, showcasing the impactful work of those dedicated to improving the tech industry. Small actions that make a difference are also recognized and appreciated.
52+
### Every individual, company, or organization that contributes positively toward resolving an issue is acknowledged and given credit for their efforts. Larger contributions will be featured on the [**TechOpenSolve**](https://techopensolve.com) website, showcasing the impactful work of those dedicated to improving the tech industry. Small actions that make a difference are also recognized and appreciated.
5353

5454
## Assigning Issues
5555

profile/CONTRIBUTING.md

+24-28
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,32 @@ If you don't find an existing issue that addresses a particular challenge, open
1616

1717
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.
1818

19-
### 4. Contributing
19+
## 4. Contributing
2020

21-
Choose one of the following options to contribute:
21+
The purpose of TechOpenSolve is to recognize and highlight real-life contributions - tangible actions that genuinely work towards improving the tech industry. We focus on addressing real-world challenges by encouraging and acknowledging efforts that foster a more inclusive, supportive, and innovative environment. Through collective action, we aim to drive meaningful change in the tech community.
2222

23-
#### Option 1: Recognize Contributions
23+
### Step 1: Identify a **Real Life** Contribution
2424

25-
Recognize existing contributions made by others:
25+
1. This can be done either by recognizing an existing real-life contribution made by others, or by making a meaningful impact yourself. Here are just a few possible suggestions to help you get started:
26+
27+
- Implementing practical solutions in real-life scenarios.
28+
- Providing jobs, support, guidance, or resources to individuals or groups affected by the issue.
29+
- Writing blog posts, creating videos, or other ways of advocating for change within organizations or communities.
30+
- Collaborating with others to brainstorm and implement innovative approaches that bring a positive impact.
31+
32+
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.
33+
34+
2. After choosing an existing contribution or completing your real life contribution, use the
35+
[Contribution Acknowledgement Template](#step-2-recognize-contributions) to document your contribution by leaving a comment.
36+
37+
## Step 2: Recognize Contributions
38+
39+
Document the selected real life contribution/s:
2640

2741
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:
2842

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:
43+
1. Navigate to the relevant repository and then to the issue topic where the contribution occurred.
44+
2. Add a comment below the issue, acknowledging the contribution and providing details and links using the following template:
3145

3246
```
3347
#### Contribution Acknowledgement:
@@ -48,34 +62,16 @@ Replace the placeholders (e.g., [Name/Username], [Description of the contributio
4862

4963
3. Ensure that the comment provides clear and detailed recognition of the contribution, including any relevant links or resources.
5064

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-
6565
### 5. Fact Checking
6666

67-
Contributions will undergo fact checking and upon determining authenticity and if they are significant then they can move on to the next stage.
67+
Every contribution acknowledgment (comment) will undergo a thorough fact-checking process. During this process, we verify the authenticity of the contribution and ensure that it aligns with the values and goals of TechOpenSolve. Only comments that are confirmed to be genuine and significant will be retained. Any comments that fail to meet these standards will be removed to maintain the integrity and quality of the contributions recognized by the project.
6868

6969
### 6. Pull Requests
7070

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-
71+
There are NO Pull Requests in this project! If you're confused about how TechOpenSolve operates, let me clarify: we tackle real-life issues in a manner similar to digital issues, but we do not use pull requests. Instead, recognized contributions are featured on the main website, automatically populated via the GitHub API. It’s crucial that comments comply with the CONTRIBUTING.md guidelines. Unauthorized comments will be deleted for non-compliance.
7872

73+
---
74+
At TechOpenSolve, we believe that collective action can drive meaningful change in the tech industry. Your contributions, whether through direct action or by recognizing the efforts of others, are vital in creating a more inclusive and innovative environment. Together, we can tackle real-life challenges and pave the way for a better future in tech. Thank you for being a part of this journey!
7975

8076

8177

profile/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Contributions towards resolving an issue can take various forms, including:
4949

5050
## Recognizing Contributions
5151

52-
Every individual, company, or organization that contributes positively toward resolving an issue is acknowledged and given credit for their efforts. Larger contributions will be featured on the TechOpenSolve website, showcasing the impactful work of those dedicated to improving the tech industry. Small actions that make a difference are also recognized and appreciated.
52+
### Every individual, company, or organization that contributes positively toward resolving an issue is acknowledged and given credit for their efforts. Larger contributions will be featured on the [**TechOpenSolve**](https://techopensolve.com) website, showcasing the impactful work of those dedicated to improving the tech industry. Small actions that make a difference are also recognized and appreciated.
5353

5454
## Assigning Issues
5555

0 commit comments

Comments
 (0)