|
1 | 1 | # CONTRIBUTING GUIDE
|
2 |
| - |
3 | 2 | ## Table of Contents
|
4 | 3 |
|
5 | 4 | - [CONTRIBUTING GUIDE](#contributing-guide)
|
6 | 5 | - [Table of Contents](#table-of-contents)
|
| 6 | + - [Reporting Bugs](#reporting-bugs) |
| 7 | + - [Suggesting New Features](#suggesting-new-features) |
| 8 | + - [Pull Request Process](#pull-request-pr-process) |
7 | 9 | - [Prerequisites](#prerequisites)
|
8 | 10 | - [Environment Setup Guide](#environment-setup-guide)
|
9 | 11 | - [Step 1: Locate the `.env.template` Files](#step-1-locate-the-envtemplate-files)
|
|
19 | 21 | - [Useful Resources](#useful-resources)
|
20 | 22 | - [Troubleshooting](#troubleshooting)
|
21 | 23 |
|
| 24 | +## Reporting Bugs |
| 25 | + |
| 26 | +To report a bug: |
| 27 | + |
| 28 | +1. **Navigate** to the **Issues** tab. |
| 29 | +2. **Click** **New Issue**. |
| 30 | +3. **Describe** your bug with: |
| 31 | + |
| 32 | + * A clear **title** |
| 33 | + * **Steps to reproduce** |
| 34 | + * **Expected vs. actual behavior** |
| 35 | + * Relevant **logs** or **screenshots** |
| 36 | + |
| 37 | +Our team reviews new issues **daily** and will respond **as soon as possible**. |
| 38 | + |
22 | 39 | ---
|
23 | 40 |
|
| 41 | +## Suggesting New Features |
| 42 | + |
| 43 | +To propose a new feature: |
| 44 | + |
| 45 | +1. **Open** the roadmap board: |
| 46 | + [https://github.com/orgs/ibm-skills-network/projects/9](https://github.com/orgs/ibm-skills-network/projects/9) |
| 47 | +2. **Add** your idea to the **TODO** column. |
| 48 | +3. **Assign** it to a team member for initial review. |
| 49 | + |
| 50 | +--- |
| 51 | + |
| 52 | +## Pull Request (PR) Process |
| 53 | + |
| 54 | +We follow **semantic conventions** for branches, versions, and PRs: |
| 55 | + |
| 56 | +### A. Conventions & Resources |
| 57 | + |
| 58 | +* **Branch Naming** |
| 59 | + [https://gist.github.com/seunggabi/87f8c722d35cd07deb3f649d45a31082](https://gist.github.com/seunggabi/87f8c722d35cd07deb3f649d45a31082) |
| 60 | +* **Semantic Versioning** |
| 61 | + [https://www.geeksforgeeks.org/introduction-semantic-versioning/](https://www.geeksforgeeks.org/introduction-semantic-versioning/) |
| 62 | +* **React Code Style** |
| 63 | + [https://developer.dynatrace.com/develop/react-style-guide/](https://developer.dynatrace.com/develop/react-style-guide/) |
| 64 | +* **Stacked PRs** |
| 65 | + [https://blog.logrocket.com/using-stacked-pull-requests-in-github/](https://blog.logrocket.com/using-stacked-pull-requests-in-github/) |
| 66 | + |
| 67 | +### B. Workflow |
| 68 | + |
| 69 | +1. **Pick up** an issue. |
| 70 | +2. **Create** a branch named per our conventions (e.g., `feature/ISSUE-123-description`). |
| 71 | +3. **Break down** large issues into multiple, focused PRs. |
| 72 | +4. **Stack** related PRs under a main branch if needed. |
| 73 | +5. **Submit** each PR for review. |
| 74 | +6. **Merge** once approved. |
| 75 | +7. **Release** a new version if the change is client-facing. |
| 76 | + |
24 | 77 | ## Prerequisites
|
25 | 78 |
|
26 | 79 | Before contributing to this project, ensure the following tools and dependencies are installed:
|
|
0 commit comments