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.md
+38-22Lines changed: 38 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,11 @@
1
-
Thank you for taking the time to contribute to our library🙌🏾.
2
-
3
-
In this section, we detail everything you need to know about contributing to this library.
4
-
1
+
Thank you for taking the time to contribute to our library🙌🏾. In this section, we detail everything you need to know about contributing to this library.
5
2
6
3
**[Code of Conduct](https://github.com/probot/template/blob/master/CODE_OF_CONDUCT.md)**
7
4
8
5
## **I don't want to contribute, I have a question**
9
-
10
6
Please don't raise an issue to ask a question. You can ask questions on our [forum](http://forum.flutterwave.com) or developer [slack](https://bit.ly/34Vkzcg). We have an army of Engineers on hand to answer your questions there.
11
7
12
8
## How can I contribute?
13
-
14
9
### Reporting a bug
15
10
16
11
Have you spotted a bug? Fantastic! Before raising an issue, here are some things to do:
@@ -29,14 +24,44 @@ When you report an issue, it is important to:
29
24
- Did you experience the bug on test mode or live?
30
25
- Do you have the recommended versions of the library dependencies?
31
26
32
-
<aside>
27
+
> 💡 Please make use of the issue template when reporting bugs.
28
+
```markdown
29
+
### Description
33
30
34
-
💡 Please make use of the issue template when reporting bugs.
31
+
<!-- Description of the issue -->
35
32
36
-
</aside>
33
+
### Steps to Reproduce
37
34
38
-
### Requesting a feature
35
+
1. <!-- First Step -->
36
+
2. <!-- Second Step -->
37
+
3. <!-- and so on… -->
38
+
39
+
**Expected behaviour:**
40
+
41
+
<!-- What you expect to happen -->
42
+
43
+
**Actual behaviour:**
44
+
45
+
<!-- What actually happens -->
46
+
47
+
**Reproduces how often:**
48
+
49
+
<!-- What percentage of the time does it reproduce? -->
39
50
51
+
### Configuration
52
+
53
+
- API Version: <!-- v2 or v3 -->
54
+
- Environment: <!-- test mode or live mode -->
55
+
- Browser: <!-- [all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView ] -->
<!-- Any additional information, configuration or data that might be necessary to reproduce the issue e.g. detailed explanation, stack traces, related issues, suggestions on how to fix, links for us to have more context like StackOverflow, Gitter, etc. -->
61
+
```
62
+
63
+
64
+
### Requesting a feature
40
65
If you need an additional feature added to the library, kindly send us an email at developers@flutterwavego.com. Be sure to include the following in your request:
41
66
42
67
1. A clear title that helps us to identify the requested feature.
@@ -45,19 +70,15 @@ If you need an additional feature added to the library, kindly send us an email
45
70
4. Library name and version.
46
71
47
72
### Submitting changes (PR)
48
-
49
73
Generally, you can make any of the following changes to the library:
50
74
51
75
1. Bug fixes
52
76
2. Performance improvement
53
77
3. Documentation update
54
78
4. Functionality change (usually new features)
55
79
56
-
<aside>
57
-
58
-
💡 Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of the library will generally not be accepted.
80
+
> 💡 Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of the library will generally not be accepted.
59
81
60
-
</aside>
61
82
62
83
Follow these steps when making a pull request to the library:
63
84
@@ -78,14 +99,9 @@ $ git commit -m "A brief summary of the commit
78
99
> A paragraph describing what changed and its impact."
79
100
```
80
101
81
-
<aside>
82
-
83
-
💡 For your pull request to be reviewed, you need to meet the requirements above. We may ask you to complete additional tests, or other changes before your pull request can be ultimately accepted.
84
-
85
-
</aside>
102
+
> 💡 For your pull request to be reviewed, you need to meet the requirements above. We may ask you to include additional tests, or changes before your pull request can be ultimately accepted.
86
103
87
104
We encourage you to contribute and help make the library better for the community. Got questions? send us a [message](https://bit.ly/34Vkzcg).
0 commit comments