Skip to content

Latest commit

 

History

History
80 lines (50 loc) · 3.83 KB

README.md

File metadata and controls

80 lines (50 loc) · 3.83 KB
Raw

Contributing Guidelines

Thank you for considering contributing to this repository! This project aims to provide a well-organized collection of real-world problem statements that designers, developers, and product builders can use as case studies or inspiration for new products. Our goal is to create a valuable knowledge base for the community, so we welcome your ideas, problem statements, and insights.

How to Contribute

There are a few ways to contribute to this project:

  1. Submit a New Problem Statement
  2. Enhance Existing Content
  3. Fix Typos or Improve Formatting

Please follow these guidelines to help maintain consistency and quality across all contributions.

1. Submitting a New Problem Statement

To contribute a new problem statement, please make sure it fits the general format below:

  • Group: This is the main category or field of the problem (e.g., Health and Wellness, Education Technology).
  • Concept: A brief description that explains the problem and its impact. Be specific about why this problem is important and who it affects.
  • Examples: Relevant tools, platforms, or real-world examples that relate to this problem, if available.
  • Readings: Links to articles, research papers, or other resources that help provide background on the issue.

Example Format:

| Group                        | Concept                                                   | Examples                        | Readings            |
|------------------------------|-----------------------------------------------------------|---------------------------------|----------------------|
| Health and Wellness          | Brief description of the issue and its impact.            | Example 1, Example 2, Example 3 | [Add link](#)       |

Steps to Submit:

  1. Fork the Repository: Click on the "Fork" button at the top of this page to create your copy of this repository.
  2. Clone Your Fork: Clone your forked repository to your local machine.
  3. Create a New Branch: Use a descriptive name for your branch (e.g., add-health-wellness-problem).
  4. Add Your Problem Statement: Follow the example format to ensure consistency.
  5. Commit Your Changes: Write a clear commit message (e.g., Add problem statement for Health and Wellness).
  6. Push the Changes to GitHub: Push your branch to your forked repository.
  7. Create a Pull Request: Go to the original repository and create a pull request with a clear title and description.

2. Enhancing Existing Content

If you’d like to add additional context, examples, or readings to an existing problem statement, please:

  • Make sure your additions are accurate and well-sourced.
  • Use concise language.
  • Only add links to reputable and reliable resources in the Readings column.

3. Fixing Typos or Improving Formatting

To maintain a professional and easy-to-read knowledge base, fixing typos, grammatical errors, or formatting issues is always appreciated. You can follow the same steps as above to submit these minor improvements.

Code of Conduct

We strive to foster an inclusive and collaborative environment. When contributing, please:

  • Be respectful and considerate in your language and feedback.
  • Review other contributors’ pull requests and offer constructive input if possible.
  • Credit all sources of information you add to the repository.

Additional Guidelines

  • License: By contributing, you agree that your contributions will be licensed under the same license as the repository.
  • Use Clear and Concise Language: Aim for clarity and readability.
  • Avoid Redundancy: Check if a similar problem statement already exists to avoid duplicating content.

Thank you for helping us build a valuable resource for the community! If you have any questions, feel free to open an issue, and we’ll be happy to assist.