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: .github/CONTRIBUTING.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,9 @@ If you wish to contribute to the **Float Toolkit** codebase, feel free to fork t
8
8
9
9
## Steps
10
10
11
-
1. Refer to the [documentation](https://float-toolkit.web.app/) to make sure the error is actually a bug and not a mistake of your own.
11
+
1. Refer to the [documentation](https://float-toolkit.web.app) to make sure the error is actually a bug and not a mistake of your own.
12
12
1. Make sure the issue hasn't already been reported or suggested.
13
13
1. Fork and clone the repository, and checkout the corresponding branch (`docs` for documentation, `master` for anything else). **DO NOT** modify the `stable` branch.
14
14
1. Make your changes (if necessary, add or modify documentation and tests to cover your changes).
15
-
1. Run `npm run buildWithDocs` (or VSCode task _NPM: Build and generate documentation_) to run the tests and build the package and the documentation (you can use `npm link` to try it locally).
15
+
1. Run `npm run buildWithDocs` (or VSCode task _NPM: Build and generate documentation_) to run the tests and build the package and documentation (you can use `npm link` to try it locally).
16
16
1.[Submit a pull request](https://github.com/float-toolkit/core/compare).
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
## Before you go ANY further...
8
8
9
-
- Refer to the [documentation](https://float-toolkit.web.app/) to make sure the error is actually a bug and not a mistake of your own.
9
+
- Refer to the [documentation](https://float-toolkit.web.app) to make sure the error is actually a bug and not a mistake of your own.
10
10
- Please help us process your issue efficiently and in detail by using one of our [issue templates](https://github.com/float-toolkit/core/issues/new/choose).
11
11
12
12
Thank you for contributing to the **Float Toolkit** codebase!
description: Is the package not working as intended?
3
-
4
3
title: BUG - (brief description)
5
4
labels:
6
5
- 🐞 Bug
@@ -18,30 +17,25 @@ body:
18
17
19
18
- type: dropdown
20
19
id: affected-packages
21
-
22
20
attributes:
23
21
label: Affected packages
24
22
description: Which packages does this bug affect?
25
23
multiple: true
26
-
27
24
options:
28
25
- "@float-toolkit/core"
29
26
- "@float-toolkit/react"
30
27
31
28
- type: input
32
29
id: package-version
33
-
34
30
attributes:
35
31
label: Package version
36
32
description: Which package version are you using? You can check it in your `package.json` file or by running `npm list <package>`.
37
33
placeholder: X.X.X
38
-
39
34
validations:
40
35
required: true
41
36
42
37
- type: textarea
43
38
id: description
44
-
45
39
attributes:
46
40
label: Description
47
41
description: |
@@ -53,13 +47,11 @@ body:
53
47
2.
54
48
3.
55
49
...
56
-
57
50
validations:
58
51
required: true
59
52
60
53
- type: textarea
61
54
id: code-sample
62
-
63
55
attributes:
64
56
label: Code sample
65
57
description: |
@@ -72,53 +64,41 @@ body:
72
64
73
65
- type: textarea
74
66
id: expected-behavior
75
-
76
67
attributes:
77
68
label: Expected behavior
78
-
79
69
validations:
80
70
required: true
81
71
82
72
- type: textarea
83
73
id: actual-behavior
84
-
85
74
attributes:
86
75
label: Actual behavior
87
-
88
76
validations:
89
77
required: true
90
78
91
79
- type: dropdown
92
80
id: priority
93
-
94
81
attributes:
95
82
label: Priority
96
83
description: How critical is this bug? (please be realistic)
97
-
98
84
options:
99
85
- Minor bug (annoying, but not crucially broken)
100
86
- Medium bug (needs attention)
101
87
- Major bug (must be fixed immediately)
102
-
103
88
validations:
104
89
required: true
105
90
106
91
- type: checkboxes
107
92
id: contribution-guidelines
108
-
109
93
attributes:
110
94
label: Contribution guidelines
111
95
description: By submitting this issue, you agree that...
112
-
113
96
options:
114
97
- label: This is a bug, not you [asking for support](https://github.com/float-toolkit/core/discussions/categories/q-a).
115
98
required: true
116
-
117
-
- label: You have read the [documentation](https://float-toolkit.web.app/) and made sure this is not intended behavior.
99
+
- label: You have read the [documentation](https://float-toolkit.web.app) and made sure this is not intended behavior.
118
100
required: true
119
-
120
101
- label: The issue has not already been reported.
121
102
required: true
122
-
123
103
- label: You are following the project's [Code of Conduct](https://github.com/float-toolkit/core/blob/master/.github/CODE_OF_CONDUCT.md) and [contribution guidelines](https://github.com/float-toolkit/core/blob/master/.github/CONTRIBUTING.md).
description: Please describe the issue in as much detail as possible. You can also attach images here.
35
31
placeholder: |
36
32
This method needs documentation...
37
33
The website has a faulty link...
38
-
39
34
validations:
40
35
required: true
41
36
42
37
- type: textarea
43
38
id: how-to-reproduce
44
-
45
39
attributes:
46
40
label: How to reproduce
47
41
description: If this is a website bug, please describe how to reproduce it.
@@ -54,44 +48,35 @@ body:
54
48
55
49
- type: textarea
56
50
id: expected-behavior
57
-
58
51
attributes:
59
52
label: Expected behavior
60
53
61
54
- type: textarea
62
55
id: actual-behavior
63
-
64
56
attributes:
65
57
label: Actual behavior
66
58
67
59
- type: dropdown
68
60
id: priority
69
-
70
61
attributes:
71
62
label: Priority
72
63
description: How critical is this issue? (please be realistic)
73
-
74
64
options:
75
65
- Minor (not crucially broken)
76
66
- Medium (needs attention)
77
67
- Major (must be fixed immediately)
78
-
79
68
validations:
80
69
required: true
81
70
82
71
- type: checkboxes
83
72
id: contribution-guidelines
84
-
85
73
attributes:
86
74
label: Contribution guidelines
87
75
description: By submitting this issue, you agree that...
88
-
89
76
options:
90
77
- label: This is a documentation issue, not you [asking for support](https://github.com/float-toolkit/core/discussions/categories/q-a).
91
78
required: true
92
-
93
79
- label: The issue has not already been reported.
94
80
required: true
95
-
96
81
- label: You are following the project's [Code of Conduct](https://github.com/float-toolkit/core/blob/master/.github/CODE_OF_CONDUCT.md) and [contribution guidelines](https://github.com/float-toolkit/core/blob/master/.github/CONTRIBUTING.md).
description: Do you have a suggestion or an idea for a new feature?
3
-
4
3
title: SUGGESTION - (brief description)
5
4
labels:
6
5
- ✨ Enhancement
@@ -18,19 +17,16 @@ body:
18
17
19
18
- type: dropdown
20
19
id: targeted-packages
21
-
22
20
attributes:
23
21
label: Targeted packages
24
22
description: Which packages should have this new feature / be considered?
25
23
multiple: true
26
-
27
24
options:
28
25
- "@float-toolkit/core"
29
26
- "@float-toolkit/react"
30
27
31
28
- type: textarea
32
29
id: description
33
-
34
30
attributes:
35
31
label: Description
36
32
description: |
@@ -40,50 +36,39 @@ body:
40
36
This new feature would be very welcome...
41
37
The lack of ___ is frustrating...
42
38
___ should behave like this instead...
43
-
44
39
validations:
45
40
required: true
46
41
47
42
- type: textarea
48
43
id: example-use-cases
49
-
50
44
attributes:
51
45
label: Example use cases
52
46
description: When and where would this feature be useful?
53
47
placeholder: This would be useful in situations where...
54
-
55
48
validations:
56
49
required: true
57
50
58
51
- type: textarea
59
52
id: other-alternatives
60
-
61
53
attributes:
62
54
label: Other alternatives
63
55
description: Have you considered any other possible approaches?
64
56
65
57
- type: checkboxes
66
58
id: contribution-guidelines
67
-
68
59
attributes:
69
60
label: Contribution guidelines
70
61
description: By submitting this issue, you agree that...
71
-
72
62
options:
73
63
- label: This is a suggestion, not you [asking for support](https://github.com/float-toolkit/core/discussions/categories/q-a).
74
64
required: true
75
-
76
-
- label: You have read the [documentation](https://float-toolkit.web.app/) and made sure this is not already implemented.
65
+
- label: You have read the [documentation](https://float-toolkit.web.app) and made sure this is not already implemented.
77
66
required: true
78
-
79
67
- label: The issue has not already been suggested.
80
68
required: true
81
-
82
69
- label: This new feature will not break any existing code.
83
70
required: true
84
-
85
71
- label: This feature fits with Float Toolkit's philosophy and goals.
86
72
required: true
87
-
88
73
- label: You are following the project's [Code of Conduct](https://github.com/float-toolkit/core/blob/master/.github/CODE_OF_CONDUCT.md) and [contribution guidelines](https://github.com/float-toolkit/core/blob/master/.github/CONTRIBUTING.md).
0 commit comments