You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributing/overview.md
+33-6Lines changed: 33 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,42 @@
2
2
3
3
You can contribute to the Halstack design system documentation in several ways:
4
4
5
-
*[Bug reports and feature requests](#bug-reports-and-feature-requests)
5
+
*[Giving feedback](#giving-feedback)
6
+
*[Discussions](#discussions)
7
+
*[Issues](#issues)
6
8
*[Content guidelines](#content-guidelines)
7
9
*[Editing pages](#editing-pages)
8
10
*[Creating pages](#creating-pages)
9
11
12
+
## Giving feedback
10
13
11
-
## Bug reports and feature requests
14
+
Halstack design system is free to use and contributors help us to make it awesome. In order to manage the feedback we have different channels depending of the nature of the topic, the following flow will help you to find the correct forum to provide your feedback:
12
15
13
-
Before opening a [new issue](https://github.com/dxc-technology/halstack-style-guide/issues/new/choose) consider the following;
The Github discussions tab is the best method to provide your opinion about anything we have (or not!) on our design system. Consider using discussions if:
24
+
25
+
* You want to **share your ideas**
26
+
* There is a **new component or variant** you would like us to have
27
+
* There is a **missing feature** you want to add to an exisiting component
28
+
* You have **any question** regarding our tools and guidelines
29
+
30
+
In case is the first time you use discussions, GitHub has an [amazing documentation](https://docs.github.com/en/discussions) available. You can open a discussion or give your opinion about the following topics:
Before submitting any comment please read the [community guidelines](https://docs.github.com/en/github/site-policy/github-community-guidelines).
37
+
38
+
### Issues
39
+
40
+
We use GitHub issues as action items for our daily basis work, before opening a [new issue](https://github.com/dxc-technology/halstack-style-guide/issues/new/choose) consider the following:
14
41
15
42
***Avoid duplicates**: Before opening a new issue please always check that the issue has not been already opened.
16
43
***Use labels**: Labels help us organizing the open issues, find a label that suits better to your feature/bug and add it.
@@ -20,17 +47,17 @@ If the issue is related to our CDKs please open it in the correct repositories:
Open a [bug report](https://github.com/dxc-technology/halstack-style-guide/issues/new?assignees=&labels=&template=bug_report.md) when there are:
26
53
27
54
* Typos in the documentation
28
55
* Incorrect or misleading information
29
56
* Broken or outdated links
30
57
31
-
### Feature request
58
+
####Feature request
32
59
33
-
All the enhancements, new component or feature requests are handle via [feature requests](https://github.com/dxc-technology/halstack-style-guide/issues/new?assignees=&labels=&template=feature_request.md). We encourage every user of Halstack design system to use this method for requesting improvements.
60
+
All the enhancements, new component or feature requests are handle via [feature requests](https://github.com/dxc-technology/halstack-style-guide/issues/new?assignees=&labels=&template=feature_request.md). Every user of Halstack design system can use this method for requesting improvements.
34
61
35
62
* Proposed and accepted features are included by the core mantainers
36
63
* Any feature can be crafted and submitted to this repo as a [pull request](#pull-requests).
0 commit comments