|
| 1 | +# ✨ Contributing Guide |
| 2 | + |
| 3 | +First off, thank you for considering contributing to DevHub! We appreciate your time and effort in helping make this project better. |
| 4 | + |
| 5 | +The following is a set of guidelines for contributing to DevHub. These are just guidelines, not rules, so use your best judgment and feel free to propose changes to this document in a pull request. |
| 6 | + |
| 7 | +## Table of Contents |
| 8 | +- [What can I contribute?](#what-can-i-contribute) |
| 9 | +- [Before You Contribute](#before-you-contribute) |
| 10 | +- [Your First Contribution](#your-first-contribution) |
| 11 | +- [Development Workflow](#development-workflow) |
| 12 | + - [Cloning the Repository](#cloning-the-repository) |
| 13 | + - [Creating a New Branch](#creating-a-new-branch) |
| 14 | + - [Making Changes](#making-changes) |
| 15 | + - [Submitting a Pull Request](#submitting-a-pull-request) |
| 16 | +- [Reporting Bugs](#reporting-bugs) |
| 17 | + - [How Do I Submit A Good Bug Report?](#how-do-i-submit-a-good-bug-report) |
| 18 | +- [Contribution Guidelines](#contribution-guidelines) |
| 19 | + - [Core Work Contributions](#core-work-contributions) |
| 20 | + - [Template Contributions](#template-contributions) |
| 21 | +- [Code of Conduct](#code-of-conduct) |
| 22 | +- [License](#license) |
| 23 | + |
| 24 | +## What can I contribute? |
| 25 | +There are several ways to contribute to this repository: |
| 26 | + |
| 27 | +1. **Feature Development**: Enhancing the feature functionalities of DevHub, including features related to matchmaking and user interaction. |
| 28 | +3. **Bug Fixes**: Identifying and resolving bugs that affect the platform's performance or user experience. |
| 29 | + |
| 30 | +## Before You Contribute |
| 31 | +Before starting to contribute, please make sure to: |
| 32 | +- **Open an issue** on GitHub or discuss your idea on our [Discord](https://discord.gg/he8QHEC8WP) to get feedback and align with the project's goals. |
| 33 | +- Review the [**Code of Conduct**](https://github.com/devhub-ai/devhub/blob/main/.github/CODE_OF_CONDUCT.md) and agree to abide by it. |
| 34 | + |
| 35 | +## Your First Contribution |
| 36 | +If you're unsure where to begin contributing, you can start by looking through the **good first issues** or **help wanted issues**. These issues are great starting points for new contributors. |
| 37 | + |
| 38 | +## Development Workflow |
| 39 | + |
| 40 | +### Cloning the Repository |
| 41 | +1. Fork the repository on GitHub. |
| 42 | +2. Clone your forked repository to your local machine. |
| 43 | +3. Navigate to the project directory in your terminal. |
| 44 | + |
| 45 | +### Creating a New Branch |
| 46 | +1. Create a new branch from the `main` branch using `git checkout -b your-branch-name`. |
| 47 | +2. Choose a descriptive name for your branch, such as `feat/add-new-feature` or `fix/bug-in-matchmaking`. |
| 48 | + |
| 49 | +### Making Changes |
| 50 | +1. Make your changes to the codebase. |
| 51 | +2. Ensure your changes follow the project's coding style and conventions. |
| 52 | +3. Add or update tests if necessary. |
| 53 | + |
| 54 | +### Submitting a Pull Request |
| 55 | +1. Push your branch to your forked repository. |
| 56 | +2. Open a pull request from your branch to the `main` branch of the original repository. |
| 57 | +3. Fill out the pull request template with relevant information and also mention any issues it resolves (if applicable). |
| 58 | +4. Reference any related issues in the pull request description. |
| 59 | +5. Wait for maintainers to review your pull request. |
| 60 | + |
| 61 | +## Reporting Bugs |
| 62 | + |
| 63 | +This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports. |
| 64 | + |
| 65 | +Before creating a new issue, **perform a cursory search** to see if the report exists. If it does, go through the discussion thread and leave a comment instead of opening a new one. |
| 66 | + |
| 67 | +If you find a **Closed** issue that is similar to what you are experiencing, open a new issue and include a link to the original case in your new one. |
| 68 | + |
| 69 | +If you cannot find an open or closed issue addressing the problem, **open a new issue**. |
| 70 | + |
| 71 | +Be sure to include: |
| 72 | +- A **clear title and description** |
| 73 | +- Relevant information |
| 74 | +- A **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. |
| 75 | + |
| 76 | +## Contribution Guidelines |
| 77 | + |
| 78 | + |
| 79 | +1. **Feature Development**: Enhancing the feature functionalities of DevHub, including features related to matchmaking and user interaction. |
| 80 | +3. **Bug Fixes**: Identifying and resolving bugs that affect the platform's performance or user experience. |
| 81 | + |
| 82 | +Every template contribution should: |
| 83 | +- Include proper documentation that provides an overview of its functionality. |
| 84 | +- Contribute relevant examples or templates that enhance user experience. |
| 85 | + |
| 86 | +## Code of Conduct |
| 87 | +By participating in this project, you agree to abide by our [Code of Conduct](https://github.com/devhub-ai/devhub/blob/main/.github/CODE_OF_CONDUCT.md). |
| 88 | + |
| 89 | +## License |
| 90 | +DevHub is licensed under the [Apache License 2.0](https://github.com/devhub-ai/devhub/blob/main/LICENSE). |
0 commit comments