Skip to content

Commit d34e6f1

Browse files
authored
Update CONTRIBUTING.md
1 parent 84d8501 commit d34e6f1

File tree

1 file changed

+54
-1
lines changed

1 file changed

+54
-1
lines changed

docs/CONTRIBUTING.md

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# CONTRIBUTING GUIDE
2-
32
## Table of Contents
43

54
- [CONTRIBUTING GUIDE](#contributing-guide)
65
- [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)
79
- [Prerequisites](#prerequisites)
810
- [Environment Setup Guide](#environment-setup-guide)
911
- [Step 1: Locate the `.env.template` Files](#step-1-locate-the-envtemplate-files)
@@ -19,8 +21,59 @@
1921
- [Useful Resources](#useful-resources)
2022
- [Troubleshooting](#troubleshooting)
2123

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+
2239
---
2340

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+
2477
## Prerequisites
2578

2679
Before contributing to this project, ensure the following tools and dependencies are installed:

0 commit comments

Comments
 (0)