Skip to content

Latest commit

 

History

History
81 lines (47 loc) · 4.15 KB

CONTRIBUTING.md

File metadata and controls

81 lines (47 loc) · 4.15 KB
Raw

Contributing to TechOpenSolve

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.

How to Contribute

1. Identify an Issue

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. If the issue does not exist continue with steps 2 and 3.

2. Open a Discussion

If you don't find an existing issue that addresses a particular challenge, open a Discussion of type Idea to suggest it. Engage with the community to gather feedback and refine the scope of the issue.

3. Document the Issue

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.

4. Contributing

Choose one of the following options to contribute:

Option 1: Recognize Contributions

Recognize existing contributions made by others:

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:

  1. Navigate to the relevant issue where the contribution occurred.
  2. Add a comment below the issue acknowledging the contribution and providing details and links using the following template:
#### Contribution Acknowledgement:

- **Contributor:** [Name/Username]
- **Contribution:** [Brief description of the action they took]
- **How does it help:** 
[Provide details about how this contribution makes a positive impact]
- **Link:** 
[Provide a link (blog post, video, company page, user profile) - most suitable link ]

Thank you, [Name/Username], and [any other individuals/companies/organizations involved], 
for your valuable contribution. 
This marks a significant step in our efforts towards resolving the issue!!

Replace the placeholders (e.g., [Name/Username], [Description of the contribution], [Link], [Additional Details]) with the appropriate information.

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

Option 2: Make a Contribution

  1. Contribute yourself by adding meaningful impact within real-life scenarios. Here are just a few possible suggestions, to help you get started:
  • Implementing practical solutions in real-life scenarios.
  • Providing jobs, support, guidance, or resources to individuals or groups affected by the issue.
  • Writing blog posts, creating videos, or other ways of advocating for change within organizations or communities.
  • Collaborating with others to brainstorm and implement innovative approaches that bring a positive impact.

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.

  1. After completing your real life contribution use the Contribution Acknowledgement Template to document your contribution by leaving a comment.

5. Fact Checking

Contributions will undergo fact checking and upon determining authenticity and if they are significant then they can move on to the next stage.

6. Pull Requests

  • Pull requests will be made only in the app repo - this is the live version of our website.
  • Pull requests will not be marking an issue as resolved.
  • Each pull request will contain a commit featuring the contribution that has been left as a comment and went through fact checking.
  • Pull Request will be matched to the appropriate category and upon successful merge will be visualized on the website.

The app repo has it's own CONTRIBUTING.md document so make sure you check it out before creating a Pull Request.